From 410f06cebdf4e52ebb22b6f0714af8e476eb1eea Mon Sep 17 00:00:00 2001 From: GH Action CI Stream Date: Fri, 15 Nov 2024 17:24:42 +0000 Subject: [PATCH] Update video openapi Spec --- .../docs/api/video-client-openapi.json | 2 +- .../docusaurus/docs/api/video-openapi.json | 2 +- openapi/chat-openapi-clientside.json | 2 +- openapi/chat-openapi-clientside.yaml | 1638 ++++-- openapi/chat-openapi.json | 2 +- openapi/chat-openapi.yaml | 2551 +++++++-- openapi/clientside-api.json | 2 +- openapi/clientside-api.yaml | 3099 +++++++---- openapi/serverside-api.json | 2 +- openapi/serverside-api.yaml | 4575 +++++++++++++---- openapi/video-openapi-clientside.json | 2 +- openapi/video-openapi-clientside.yaml | 1476 ++++-- openapi/video-openapi.json | 2 +- openapi/video-openapi.yaml | 621 ++- 14 files changed, 10273 insertions(+), 3703 deletions(-) diff --git a/docusaurus/video/docusaurus/docs/api/video-client-openapi.json b/docusaurus/video/docusaurus/docs/api/video-client-openapi.json index 4912b142..7c8cef48 100644 --- a/docusaurus/video/docusaurus/docs/api/video-client-openapi.json +++ b/docusaurus/video/docusaurus/docs/api/video-client-openapi.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"},"AWSRekognitionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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":{"nullable":true,"type":"object"},"AcceptCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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/UserObject","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"moderation_enabled":{"type":"boolean","x-stream-index":"043"},"name":{"type":"string","x-stream-index":"001"},"video_provider":{"type":"string","x-stream-index":"038"}},"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"],"type":"object"},"Attachment":{"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"},"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"002"}},"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"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/UserObject","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/UserObject","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"type":"array","x-stream-index":"002"}},"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","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","action"],"type":"object"},"BlockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"BlockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-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"},"BodyguardConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"profile":{"type":"string","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"003"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"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":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"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-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"}},"required":["text","start_time","end_time","speaker_id"],"type":"object"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallEvent":{"nullable":true,"properties":{"additional":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"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":"003"},"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","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","x-stream-index":"001"}},"required":["rtmp"],"title":"Call inputs","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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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"},"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"],"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"},"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"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"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"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"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":{"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRequest":{"properties":{"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"}},"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"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":"020"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"013"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"018"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"022"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"019"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"016"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"014"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"021"},"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","backstage","settings","blocked_user_ids","ingress","egress"],"title":"Call","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-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-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-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-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-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-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-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"},"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"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"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-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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"type":"object"},"CallStateResponseFields":{"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"],"type":"object"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"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"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"truncated_by":{"$ref":"#/components/schemas/UserObject","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":{"description":"Channel configuration overrides","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"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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"},"title":"Grants","type":"object","x-stream-index":"002","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","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-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-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-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/UserObject","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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ChannelMember":{"nullable":true,"properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"017"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"016"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"021"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","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":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"009"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"010"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"008"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"022"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"title":"User ID","type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"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":"016"},"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":"017"},"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":"015"},"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","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/UserObject","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":"021"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"022"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"027"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"Config","x-stream-index":"017"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"024"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/UserObject","description":"Creator of the channel","title":"Created by","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"012"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"026"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"023"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"003"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"006"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"015"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"014"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"019"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"018"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"type":"string"},"title":"Own Capabilities","type":"array","x-stream-index":"025"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"020"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"Truncated At","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"029"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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-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-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-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/UserObject","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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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":["user_session_id","sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["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"},"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"type":"object"},"CreateDeviceRequest":{"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"],"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":"004"},"position":{"format":"int32","type":"integer","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteCallRequest":{"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"}},"type":"object"},"DeleteCallResponse":{"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":"003.001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["call","duration"],"type":"object"},"DeleteChannelResponse":{"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"],"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":{"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"],"type":"object"},"DeleteRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"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":"Device","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"}},"required":["playlist_url"],"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"},"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":{"nullable":true,"type":"object"},"EndCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"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":{"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"],"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":"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/UserObject","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/UserObject","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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"reason":{"type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id","reason"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"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":"003"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"004.002"}},"required":["type","created_at"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"type":"object"},"GetApplicationResponse":{"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"],"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"},"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"],"type":"object"},"GetCallStatsResponse":{"nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"type":"object"},"GetEdgesResponse":{"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"],"type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/Message"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"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"],"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"}},"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"],"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":{"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"],"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_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"type":"object"},"GoLiveResponse":{"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"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"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"],"type":"object"},"HLSSettingsResponse":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"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"},"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"],"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"}},"type":"object"},"HideChannelResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"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"},"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"],"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"],"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":{"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"},"LayoutSettingsRequest":{"properties":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"type":"object"},"ListRecordingsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"items":{"$ref":"#/components/schemas/CallTranscription"},"type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"type":"object"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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/UserObject","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-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":"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MemberRequest":{"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"],"type":"object"},"MemberResponse":{"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"],"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/UserObject","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-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":{"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":"011"},"before_message_send_failed":{"description":"Whether `before_message_send webhook` failed or not. Field is only accessible in push webhook","title":"Before Message Send Failed","type":"boolean","x-stream-docs-page-id":"before_message_send_webhook","x-stream-index":"045"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"027"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"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":"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":"043"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","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":"039"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Latest reactions","type":"array","x-stream-index":"012"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserObject"},"title":"Mentioned Users","type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"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":"005"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Own reactions","type":"array","x-stream-index":"013"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"018"},"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":"050"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"046"},"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":"047"},"pinned_by":{"$ref":"#/components/schemas/UserObject","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"024"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"023"},"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":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"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":"015"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"021"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"035"},"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":"020"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"044"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"004"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserObject"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"026"},"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":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/UserObject","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"010"}},"required":["id","text","html","type","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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-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/UserObject"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":"AI moderation response","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":"Moderation 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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"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"},"last_read_message_id":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"004.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"message.read","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"001.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"MessageReadEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"008"},"cid":{"type":"string","x-stream-index":"021"},"command":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"html":{"type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"029"},"id":{"type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"027"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"mml":{"type":"string","x-stream-index":"003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"010"},"parent_id":{"type":"string","x-stream-index":"014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"034"},"pinned":{"type":"boolean","x-stream-index":"031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"037"},"poll_id":{"type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"019"},"quoted_message_id":{"type":"string","x-stream-index":"018"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"016"},"shadowed":{"type":"boolean","x-stream-index":"026"},"show_in_channel":{"type":"boolean","x-stream-index":"015"},"silent":{"type":"boolean","x-stream-index":"030"},"text":{"type":"string","x-stream-index":"002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"020"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"023"},"user":{"$ref":"#/components/schemas/UserResponse","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"],"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/UserObject"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessageWithChannelResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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","channel"],"type":"object"},"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"},"ModerationConfig":{"nullable":true,"properties":{"async":{"type":"boolean","x-stream-index":"005"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"007"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"008"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"006"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"011"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"009"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"010"},"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"012"},"key":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"013"}},"required":["key","async","created_at","updated_at"],"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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationEvent":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ModerationEventActionLog","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"flags":{"items":{"$ref":"#/components/schemas/ModerationEventFlag"},"type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"review_queue_item":{"$ref":"#/components/schemas/ModerationEventReviewQueueItem","x-stream-index":"001"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"ModerationEventActionLog":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"007"},"type":{"type":"string","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ModerationEventFlag":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"reason":{"type":"string","x-stream-index":"003"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"006"},"type":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user_id","result","created_at","updated_at"],"type":"object"},"ModerationEventReviewQueueItem":{"properties":{"assigned_to":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"010"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"016"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"007"},"recommended_action":{"type":"string","x-stream-index":"009"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"severity":{"format":"int32","type":"integer","x-stream-index":"012"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by"],"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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","type":"object","x-stream-event-client-type":true,"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"},"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"},"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"],"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"],"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"}},"type":"object"},"MuteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-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-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-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-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/UserObject","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-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/UserObject","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-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/UserObject","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-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/UserObject","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-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"},"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/UserObject","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-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-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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"014"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"042"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"027"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"025"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"type":"string","x-stream-index":"032"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"026"},"online":{"type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"033"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"028"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"031"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"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"],"type":"object"},"PinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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/UserObject","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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.closed","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"type":"object"},"PollDeletedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.deleted","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"020"},"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":"018"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"created_by_id":{"type":"string","x-stream-index":"016"},"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_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":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"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","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollUpdatedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.updated","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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/UserObject","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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_casted","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteChangedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_changed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteRemovedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_removed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":{"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"],"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":{"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"],"type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"004"},"watch":{"type":"boolean","x-stream-index":"001"}},"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"],"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"},"QueryMembersPayload":{"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"],"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/SortParam"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"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"],"type":"object"},"QueryModerationConfigsRequest":{"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/SortParamRequest"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"items":{"$ref":"#/components/schemas/ModerationConfig"},"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"},"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":{"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"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"lock_moderator_duration":{"type":"integer","x-stream-index":"004"},"lock_moderator_id":{"type":"string","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"stats_only":{"type":"boolean","x-stream-index":"005"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItem"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"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":{"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"],"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMP Ingress","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"}},"type":"object"},"RTMPSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"type":"object"},"Reaction":{"description":"Represents user reaction to a message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"description":"ID of a message user reacted to","title":"Message ID","type":"string","x-stream-index":"003"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"007"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"description":"ID of a user who reacted to a message","title":"User ID","type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"number","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"number","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionRemovalResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"type":"object"},"ReactionRequest":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"format":"int32","type":"integer","x-stream-index":"002"},"type":{"maxLength":30,"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["type"],"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"},"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Read":{"nullable":true,"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/UserObject","x-stream-index":"001"}},"required":["last_read","unread_messages"],"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":"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"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"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"],"type":"object"},"RecordSettingsResponse":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ReviewQueueItem":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"027"},"assigned_to":{"$ref":"#/components/schemas/UserObject","x-stream-index":"024"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"025"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"016"},"content_changed":{"type":"boolean","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/UserObject","x-stream-index":"023"},"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":"029"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"030"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"022"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"015"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"019"},"reviewed_by":{"type":"string","x-stream-index":"020"},"severity":{"format":"int32","type":"integer","x-stream-index":"018"},"status":{"type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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"},"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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"},"SendCallEventRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, -1 for descending, 1 for ascending","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"},"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"},"StartHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StartHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"playlist_url":{"type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"type":"object"},"StartRTMPBroadcastsRequest":{"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"],"type":"object"},"StartRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StatsOptions":{"properties":{"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"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"],"type":"object"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopLiveRequest":{"nullable":true,"type":"object"},"StopLiveResponse":{"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"],"type":"object"},"StopRTMPBroadcastsRequest":{"nullable":true,"type":"object"},"StopRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopTranscriptionRequest":{"nullable":true,"type":"object"},"StopTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"SyncRequest":{"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"],"type":"object"},"SyncResponse":{"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"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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":"002"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"011"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"010"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"004"},"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":"009"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","description":"User is the user object","title":"User","x-stream-index":"007"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"006"}},"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/UserObject","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/Message","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":{"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"},"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/Read"},"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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/UserObject","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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnblockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"UnblockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-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":{"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"],"type":"object"},"UnpinRequest":{"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"],"type":"object"},"UnpinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"UpdateCallMembersRequest":{"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"}},"type":"object"},"UpdateCallMembersResponse":{"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"],"type":"object"},"UpdateCallRequest":{"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"}},"type":"object"},"UpdateCallResponse":{"description":"Represents 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":"Call","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"}},"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"},"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":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"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"],"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"},"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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/UserObject","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/UserObject","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-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/UserObject","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"image":{"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"004"}},"required":["name","image","custom","roles"],"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/UserObject","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/UserObject","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserObject":{"description":"Represents chat user","properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"015"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"014"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","readOnly":true,"title":"Deactivated at","type":"number","x-stream-index":"012"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","readOnly":true,"title":"Deleted at","type":"number","x-stream-index":"011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"032"},"last_active":{"description":"Date of last activity","format":"date-time","readOnly":true,"title":"Last active","type":"number","x-stream-index":"010"},"online":{"description":"Whether a user online or not","readOnly":true,"title":"Online","type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"039"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"004"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"033"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"title":"User object","type":"object"},"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/UserObject","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"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/UserObject","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-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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"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/UserObject","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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"VelocityFilterConfig":{"properties":{"cascading_actions":{"type":"boolean","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules","cascading_actions"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"timeout":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["action","shadow_ban","ip_ban","cascading_threshold","cascading_action"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoResolution","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"VideoResolution":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"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":{"Option":{"$ref":"#/components/schemas/PollOption","x-stream-index":"003"},"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"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"],"type":"object"},"WSChannelEvent":{"description":"The discriminator object for all websocket channel events, it maps events' payload to the final type","discriminator":{"mapping":{"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"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"}]},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"*":"#/components/schemas/AnyEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","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.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.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_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","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.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.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$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/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/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/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/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","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.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_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","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_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","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.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","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","review_queue_item.new":"#/components/schemas/ModerationEvent","review_queue_item.updated":"#/components/schemas/ModerationEvent","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/AnyEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$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/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/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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"],"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":"v133.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":"Successful response"},"400":{"content":{"application/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/chat/channels":{"post":{"description":"Query channels with filter query\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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"}}},"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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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":"Successful response"},"400":{"content":{"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","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":"Successful response"},"400":{"content":{"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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"description":"Successful response"},"400":{"content":{"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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadMessageFlags\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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":"Successful response"},"400":{"content":{"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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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":"Successful response"},"400":{"content":{"application/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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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":"Successful response"},"400":{"content":{"application/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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":"Moderation v2 ban\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":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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 configs","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 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/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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCallStats\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"Call"},"400":{"content":{"application/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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- JoinCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- SendEvent\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"Successful response"},"400":{"content":{"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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateCall\n- JoinCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- EndCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteUsers\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateCallReaction\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListRecordings\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- JoinCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"Successful response"},"400":{"content":{"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}/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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":"Successful response"},"400":{"content":{"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartTranscription\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":"Successful response"},"400":{"content":{"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopRecording\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopTranscription\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListTranscriptions\n","operationId":"ListTranscriptions","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/ListTranscriptionsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCallPermissions\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteRecording\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteTranscription\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://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"},"AWSRekognitionConfig":{"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"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"009"},"target_user_id":{"type":"string","x-stream-index":"010"},"type":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"moderation_enabled":{"type":"boolean","x-stream-index":"043"},"name":{"type":"string","x-stream-index":"001"},"video_provider":{"type":"string","x-stream-index":"038"}},"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"],"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":"021"},"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":"022"},"image_url":{"type":"string","x-stream-index":"011"},"latitude":{"format":"float","type":"number","x-stream-index":"018"},"longitude":{"format":"float","type":"number","x-stream-index":"019"},"og_scrape_url":{"type":"string","x-stream-index":"023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"024"},"pretext":{"type":"string","x-stream-index":"004"},"stopped_sharing":{"type":"boolean","x-stream-index":"020"},"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"},"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"],"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"},"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"},"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":"005"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"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"},"BlockListRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","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-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"},"BodyguardConfig":{"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"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallEvent":{"nullable":true,"properties":{"category":{"type":"string","x-stream-index":"009"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"issue_tags":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"kind":{"type":"string","x-stream-index":"008"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal","kind"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"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":"003"},"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","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"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-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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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"},"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"],"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"},"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"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"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"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"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":{"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"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"},"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-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-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-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-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-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-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-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"},"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"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"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-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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"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"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"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"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"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":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"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":{"description":"Channel configuration overrides","properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.028"},"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"}},"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","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-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-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-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-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-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":{"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","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-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","create-call","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-call","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-typing-events","set-channel-cooldown","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"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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":["user_session_id","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"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key","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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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":"004"},"position":{"format":"int32","type":"integer","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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"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"},"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"},"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"}},"required":["playlist_url"],"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"},"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"},"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":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.016"},"banned":{"type":"boolean","x-stream-index":"001.015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"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.022"},"language":{"type":"string","x-stream-index":"001.033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"001.024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.040"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"}},"required":["id","role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"description":"User response object","properties":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.001.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.001.010"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.001.013"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.001.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.001.014"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.001.007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible","ban_count","deleted_content_count"],"title":"UserResponse","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"},"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":"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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"Flag2Response":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"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_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["user_id","entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"reason":{"maxLength":255,"type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"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":"002.001"},"item_id":{"type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"title":"Response","type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"004.002"}},"required":["type","created_at"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"},"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"},"GetCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"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.021"},"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.022"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"latitude":{"format":"float","type":"number","x-stream-index":"001.018"},"longitude":{"format":"float","type":"number","x-stream-index":"001.019"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.024"},"pretext":{"type":"string","x-stream-index":"001.004"},"stopped_sharing":{"type":"boolean","x-stream-index":"001.020"},"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_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"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"}},"required":["enabled"],"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"},"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"],"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"}},"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"},"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"},"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"},"LayoutSettingsRequest":{"properties":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"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"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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-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":"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-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-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":"011"},"before_message_send_failed":{"type":"boolean","x-stream-index":"045"},"cid":{"type":"string","x-stream-index":"027"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"043"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"039"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"012"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"mml":{"type":"string","x-stream-index":"005"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"parent_id":{"type":"string","x-stream-index":"018"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"050"},"pinned":{"type":"boolean","x-stream-index":"046"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"047"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"024"},"quoted_message_id":{"type":"string","x-stream-index":"023"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"021"},"shadowed":{"type":"boolean","x-stream-index":"035"},"show_in_channel":{"type":"boolean","x-stream-index":"020"},"silent":{"type":"boolean","x-stream-index":"044"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"026"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"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":"008"},"last_read_message_id":{"type":"string","x-stream-index":"009"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"005"},"type":{"default":"message.read","type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["cid","channel_id","channel_type","type","created_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":25,"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":"038"},"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":{"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":"021"},"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":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"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":"029"},"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":"027"},"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":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"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"},"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":"014"},"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":"034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"031"},"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":"032"},"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":"033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"018"},"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":"013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"016"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"026"},"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":"015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"030"},"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":"020"},"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":"023"},"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"],"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-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-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-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.021"},"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.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"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.029"},"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.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"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"},"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.014"},"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.034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.031"},"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.032"},"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.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.036"},"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.019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.018"},"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.013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.016"},"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.026"},"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.015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.030"},"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.020"},"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.023"},"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","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationEvent":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"flags":{"items":{"$ref":"#/components/schemas/Flag2Response"},"type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"001"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"002.002"}},"required":["type","created_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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"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"},"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-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-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-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-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-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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"043"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"026"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"011"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"027"},"online":{"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"031"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"032"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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"},"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-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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.closed","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"type":"object"},"PollDeletedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.deleted","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"021"},"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"},"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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.updated","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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"},"PollVoteCastedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_casted","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteChangedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_changed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteRemovedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_removed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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"},"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"},"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":{},"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/SortParamRequest"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"description":"Basic response information","nullable":true,"properties":{"configs":{"items":{"$ref":"#/components/schemas/ConfigResponse"},"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"],"title":"Response","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"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"format":"int32","maximum":25,"minimum":1,"type":"integer","x-stream-index":"005"},"lock_duration":{"type":"integer","x-stream-index":"004"},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"stats_only":{"type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"description":"Basic response information","nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"title":"Response","type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"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"},"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"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionRemovalResponse":{"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/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"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-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"},"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"},"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":"028"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"025"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"026"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"017"},"content_changed":{"type":"boolean","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"024"},"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":"030"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"031"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"027"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"023"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"016"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"020"},"reviewed_by":{"type":"string","x-stream-index":"021"},"severity":{"format":"int32","type":"integer","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"015"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"type":"array","x-stream-index":"020"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"018"},"completed_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","x-stream-index":"015"},"entity_creator_id":{"type":"string","x-stream-index":"016"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"021"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"022"},"flags":{"items":{"$ref":"#/components/schemas/Flag2Response"},"type":"array","x-stream-index":"019"},"id":{"type":"string","x-stream-index":"001"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"008"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"010"},"reviewed_by":{"type":"string","x-stream-index":"011"},"severity":{"format":"int32","type":"integer","x-stream-index":"013"},"status":{"type":"string","x-stream-index":"007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","bans","flags","actions"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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"},"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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"},"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"},"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,"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartTranscriptionRequest","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":{"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms"],"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,"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"},"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,"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,"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":{"enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock"],"type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","x-stream-index":"006"},"item_id":{"type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"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"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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"},"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-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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"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"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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-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-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-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"},"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"},"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":"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"ban_expires":{"format":"date-time","type":"number","x-stream-index":"016"},"banned":{"type":"boolean","x-stream-index":"015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"040"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"}},"required":["id","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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"002"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"005"}},"required":["id","name","image","custom","roles"],"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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"VelocityFilterConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"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"],"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"},"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"}},"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"],"type":"object"},"VideoDimension":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoDimension","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"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":{"Option":{"$ref":"#/components/schemas/PollOptionResponseData","x-stream-index":"003"},"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"},"WSChannelEvent":{"description":"The discriminator object for all websocket channel events, it maps events' payload to the final type","discriminator":{"mapping":{"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"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"}]},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"*":"#/components/schemas/AnyEvent","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.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.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.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_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","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.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.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AnyEvent"},{"$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/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/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/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/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/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","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.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.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_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","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_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","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.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","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","review_queue_item.new":"#/components/schemas/ModerationEvent","review_queue_item.updated":"#/components/schemas/ModerationEvent","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/AnyEvent"},{"$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/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/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/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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":"v137.0.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/chat/channels":{"post":{"description":"Query channels with filter query\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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","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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","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\nRequired permissions:\n- ReadMessageFlags\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Moderation v2 ban\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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":"Response"},"400":{"content":{"application/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 configs","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\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":"Moderation v2 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":"Response"},"400":{"content":{"application/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":"Moderation v2 submit action\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 submit 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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- ReadCallStats\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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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\nRequired permissions:\n- JoinCall\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- DeleteCall\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\nRequired permissions:\n- SendEvent\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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- JoinCall\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\nRequired permissions:\n- EndCall\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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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\nRequired permissions:\n- MuteUsers\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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- CreateCallReaction\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\nRequired permissions:\n- ListRecordings\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\nRequired permissions:\n- JoinCall\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}/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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StartClosedCaptions\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"}}],"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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\nRequired permissions:\n- StartTranscription\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"}}},"description":"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopClosedCaptions\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"}}],"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"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\nRequired permissions:\n- StopRecording\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\nRequired permissions:\n- StopTranscription\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"}}],"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\nRequired permissions:\n- ListTranscriptions\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- UpdateCallPermissions\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\nRequired permissions:\n- DeleteRecording\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\nRequired permissions:\n- DeleteTranscription\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\nRequired permissions:\n- ReadCall\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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://stream-io-api.com"}]} \ No newline at end of file diff --git a/docusaurus/video/docusaurus/docs/api/video-openapi.json b/docusaurus/video/docusaurus/docs/api/video-openapi.json index 503d1b4d..34bfb998 100644 --- a/docusaurus/video/docusaurus/docs/api/video-openapi.json +++ b/docusaurus/video/docusaurus/docs/api/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"},"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","notification_template"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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/UserObject","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"005"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["id","created_at","type","reason","custom"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"type":"object"},"AppResponseFields":{"properties":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"039"},"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":"042"},"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"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"041"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"040"},"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_enabled":{"type":"boolean","x-stream-index":"043"},"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"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"video_provider":{"type":"string","x-stream-index":"038"},"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"],"type":"object"},"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":{"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"002"}},"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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/UserObject","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/UserObject","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"004"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"type":"array","x-stream-index":"002"}},"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"},"BlockListResponse":{"description":"Block list contains restricted words","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"003"},"type":{"description":"Block list type.","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":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"005"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","action"],"type":"object"},"BlockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"BlockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"BodyguardConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"profile":{"type":"string","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"003"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"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"},"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":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"type":"object"},"CallEvent":{"nullable":true,"properties":{"additional":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal"],"type":"object"},"CallIngressResponse":{"properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","x-stream-index":"001"}},"required":["rtmp"],"title":"Call inputs","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"},"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"},"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"],"type":"object"},"CallRequest":{"properties":{"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"}},"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"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":"020"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"013"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"018"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"022"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"019"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"016"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"014"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"021"},"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","backstage","settings","blocked_user_ids","ingress","egress"],"title":"Call","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":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"007"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"009"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"008"},"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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"type":"object"},"CallStateResponseFields":{"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"],"type":"object"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"CallTypeResponse":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"external_storage":{"type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"truncated_by":{"$ref":"#/components/schemas/UserObject","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":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.025"},"blocklist":{"type":"string","x-stream-index":"001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.023"},"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.018"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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"},"title":"Grants","type":"object","x-stream-index":"002","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands"],"type":"object"},"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"},"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"},"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":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"017"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"016"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"021"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","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":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"009"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"010"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"008"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"022"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"title":"User ID","type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"properties":{"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":"016"},"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":"017"},"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":"015"},"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","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/UserObject","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"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":"021"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"022"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"027"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"Config","x-stream-index":"017"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"024"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/UserObject","description":"Creator of the channel","title":"Created by","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"012"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"026"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"023"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"003"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"006"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"015"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"014"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"019"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"018"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"type":"string"},"title":"Own Capabilities","type":"array","x-stream-index":"025"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"020"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"Truncated At","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"029"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"commands":{"description":"List of commands that channel supports","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands"],"type":"object"},"CheckExternalStorageResponse":{"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"],"type":"object"},"CheckPushRequest":{"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"},"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":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"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":"007.001"},"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":"004"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"005"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"006"},"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":{"type":"string","x-stream-index":"005"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"test_mode":{"type":"boolean","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"004"},"recommended_action":{"type":"string","x-stream-index":"003"},"status":{"type":"string","x-stream-index":"001"},"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"},"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":["user_session_id","sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["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"},"Config":{"properties":{"app_certificate":{"type":"string","x-stream-index":"002"},"app_id":{"type":"string","x-stream-index":"001"},"default_role":{"enum":["attendee","publisher","subscriber","admin"],"type":"string","x-stream-index":"003"},"role_map":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["app_id","app_certificate"],"type":"object"},"ConfigResponse":{"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key","async","created_at","updated_at"],"type":"object"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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"},"type":{"description":"Block list type.","enum":["regex","domain","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"},"CreateCallTypeRequest":{"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"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"required":["name"],"type":"object"},"CreateCallTypeResponse":{"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"],"type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Enables automatic message moderation","enum":["disabled","simple","AI"],"title":"Auto moderation","type":"string","x-stream-index":"017"},"automod_behavior":{"description":"Sets behavior of automatic moderation","enum":["flag","block"],"title":"Auto moderation behavior","type":"string","x-stream-index":"018"},"blocklist":{"description":"Name of the blocklist to use","title":"Blocklist","type":"string","x-stream-index":"022"},"blocklist_behavior":{"description":"Sets behavior of blocklist","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"023"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"024"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"019"},"connect_events":{"description":"Connect events support","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Enables custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"021"},"mark_messages_pending":{"description":"Marks messages as pending by default","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Number of maximum message characters","format":"int32","title":"Maximum message length","type":"integer","x-stream-index":"016"},"message_retention":{"type":"string","x-stream-index":"015"},"mutes":{"description":"Enables mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"format":"int32","minimum":10,"type":"integer","x-stream-index":"025"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"026"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"020"},"polls":{"description":"Enables polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Enables push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Enables message reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events support","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Enables message search","title":"Search","type":"boolean","x-stream-index":"007"},"typing_events":{"description":"Typing events support","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Enables file uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"Enables URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"}},"required":["name","max_message_length","automod","automod_behavior"],"type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.025"},"blocklist":{"type":"string","x-stream-index":"001.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Represents custom chat 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":"Command","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","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"},"CreateDeviceRequest":{"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"],"type":"object"},"CreateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"type":"object"},"CreateExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"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"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"position":{"format":"int32","type":"integer","x-stream-index":"003"},"text":{"description":"Option text","title":"string","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"}},"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":{"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"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"name":{"type":"string","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"007"},"recommended_action":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"008.001"},"id":{"type":"string","x-stream-index":"001"},"moderator_action":{"type":"string","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"002"},"report":{"additionalProperties":{},"type":"array","x-stream-index":"004"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"007"},"scored_at":{"format":"date-time","type":"number","x-stream-index":"005"},"status":{"type":"string","x-stream-index":"003"}},"required":["id","recommended_action","status","report","scored_at","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":{"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"],"type":"object"},"DeactivateUsersResponse":{"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"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteCallRequest":{"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"}},"type":"object"},"DeleteCallResponse":{"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":"003.001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["call","duration"],"type":"object"},"DeleteChannelResponse":{"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"],"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":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","duration"],"type":"object"},"DeleteExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"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"],"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"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"},"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.006"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.005"},"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":{"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":"Device","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"},"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"}},"required":["playlist_url"],"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"},"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":{"nullable":true,"type":"object"},"EndCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"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"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled","apns"],"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":{"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"],"type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":25,"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"},"ExportChannelsResult":{"properties":{"path":{"description":"S3 path of result","title":"PathPrefix","type":"string","x-stream-index":"002"},"s3_bucket_name":{"description":"S3 bucket name result","title":"S3 bucket name","type":"string","x-stream-index":"003"},"url":{"description":"URL of result","title":"URL","type":"string","x-stream-index":"001"}},"required":["url"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"},"reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","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":{"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"],"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"},"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":"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","notification_template","data_template","apn_template"],"type":"object"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"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","reason"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item_id":{"type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"type":"object"},"GetApplicationResponse":{"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"],"type":"object"},"GetBlockListResponse":{"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":"Get Block list response","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"},"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"],"type":"object"},"GetCallStatsResponse":{"nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"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"],"type":"object"},"GetChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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":{"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands","duration"],"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"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"GetCustomPermissionResponse":{"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"],"type":"object"},"GetEdgesResponse":{"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"],"type":"object"},"GetExportChannelsStatusResponse":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.007.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Contains task error in case of failure","title":"Error","x-stream-index":"003"},"result":{"$ref":"#/components/schemas/ExportChannelsResult","description":"Contains task result in case of success","title":"ExportChannelsResult","x-stream-index":"002"},"status":{"description":"Task status","enum":["waiting","pending","running","completed","failed","canceled"],"title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"type":"object"},"GetImportResponse":{"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"],"type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/Message"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"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"],"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"}},"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"],"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":{"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"],"type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"history":{"items":{"$ref":"#/components/schemas/ReviewQueueItem"},"type":"array","x-stream-index":"002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["history","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"},"GetUserModerationReportResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_blocks":{"items":{"$ref":"#/components/schemas/UserBlock"},"type":"array","x-stream-index":"003"},"user_mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"002"}},"required":["user","user_mutes","user_blocks","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"type":"object"},"GoLiveResponse":{"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"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"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"],"type":"object"},"HLSSettingsResponse":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":"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"},"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":{"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":{"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":{"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"ListBlockListResponse":{"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"],"type":"object"},"ListCallTypeResponse":{"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"],"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"],"type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"type":"object"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"type":"object"},"ListExternalStorageResponse":{"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"],"type":"object"},"ListImportsResponse":{"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"],"type":"object"},"ListPermissionsResponse":{"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"],"type":"object"},"ListPushProvidersResponse":{"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"],"type":"object"},"ListRecordingsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"type":"object"},"ListRolesResponse":{"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"],"type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"items":{"$ref":"#/components/schemas/CallTranscription"},"type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"type":"object"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"type":"object"},"MemberRequest":{"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"],"type":"object"},"MemberResponse":{"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"],"type":"object"},"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":{"description":"Represents any chat message","nullable":true,"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":"011"},"before_message_send_failed":{"description":"Whether `before_message_send webhook` failed or not. Field is only accessible in push webhook","title":"Before Message Send Failed","type":"boolean","x-stream-docs-page-id":"before_message_send_webhook","x-stream-index":"045"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"027"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"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":"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":"043"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","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":"039"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Latest reactions","type":"array","x-stream-index":"012"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserObject"},"title":"Mentioned Users","type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"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":"005"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Own reactions","type":"array","x-stream-index":"013"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"018"},"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":"050"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"046"},"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":"047"},"pinned_by":{"$ref":"#/components/schemas/UserObject","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"024"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"023"},"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":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"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":"015"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"021"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"035"},"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":"020"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"044"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"004"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserObject"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"026"},"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":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/UserObject","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"010"}},"required":["id","text","html","type","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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"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"},"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"},"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":"AI moderation response","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":"Moderation 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"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"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"},"last_read_message_id":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"004.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"001.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"MessageReadEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"020.002"},"user_id":{"type":"string","x-stream-index":"020.001"}},"type":"object"},"MessageResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"008"},"cid":{"type":"string","x-stream-index":"021"},"command":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"html":{"type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"029"},"id":{"type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"027"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"mml":{"type":"string","x-stream-index":"003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"010"},"parent_id":{"type":"string","x-stream-index":"014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"034"},"pinned":{"type":"boolean","x-stream-index":"031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"037"},"poll_id":{"type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"019"},"quoted_message_id":{"type":"string","x-stream-index":"018"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"016"},"shadowed":{"type":"boolean","x-stream-index":"026"},"show_in_channel":{"type":"boolean","x-stream-index":"015"},"silent":{"type":"boolean","x-stream-index":"030"},"text":{"type":"string","x-stream-index":"002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"020"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"023"},"user":{"$ref":"#/components/schemas/UserResponse","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"],"type":"object"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageWithChannelResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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","channel"],"type":"object"},"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"},"ModerationConfig":{"nullable":true,"properties":{"async":{"type":"boolean","x-stream-index":"005"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"007"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"008"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"006"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"011"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"009"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"010"},"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"012"},"key":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"013"}},"required":["key","async","created_at","updated_at"],"type":"object"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"ModerationUsageStats":{"nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"003"},"metric":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"value":{"format":"int32","type":"integer","x-stream-index":"007"}},"required":["bucket","updated_at","metric","value"],"type":"object"},"ModeratorStats":{"nullable":true,"properties":{"action_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"items_reviewed":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["id","items_reviewed","action_counts"],"type":"object"},"ModeratorStatsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"moderator_stats":{"items":{"$ref":"#/components/schemas/ModeratorStats"},"type":"array","x-stream-index":"001"}},"required":["moderator_stats","duration"],"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"],"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"],"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"}},"type":"object"},"MuteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"014"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"042"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"027"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"025"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"type":"string","x-stream-index":"032"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"026"},"online":{"type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"033"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"028"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"031"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"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"},"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"},"PinRequest":{"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"],"type":"object"},"PinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"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/UserObject","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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"020"},"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":"018"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"created_by_id":{"type":"string","x-stream-index":"016"},"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_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":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"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","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/UserObject","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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2"],"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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"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"},"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"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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":{"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"],"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":{"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"],"type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"004"}},"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"],"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"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"templates":{"items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryMembersPayload":{"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"],"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/SortParam"},"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":{"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"],"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":{},"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/SortParamRequest"},"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":{"items":{"$ref":"#/components/schemas/ModerationConfig"},"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"},"QueryModerationLogsRequest":{"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/SortParamRequest"},"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":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"logs":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"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":{"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"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"lock_moderator_duration":{"type":"integer","x-stream-index":"004"},"lock_moderator_id":{"type":"string","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"stats_only":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItem"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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"},"QueryUsageStatsRequest":{"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/SortParamRequest"},"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"},"QueryUsageStatsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"items":{"items":{"$ref":"#/components/schemas/ModerationUsageStats"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["items","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"},"QueueStatsResponse":{"nullable":true,"properties":{"avg_time_to_action":{"type":"integer","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"time_to_action_buckets":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"}},"required":["avg_time_to_action","time_to_action_buckets","duration"],"type":"object"},"RTMPBroadcastRequest":{"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"],"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMP Ingress","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"}},"type":"object"},"RTMPSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"type":"object"},"Reaction":{"description":"Represents user reaction to a message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"description":"ID of a message user reacted to","title":"Message ID","type":"string","x-stream-index":"003"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"007"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"description":"ID of a user who reacted to a message","title":"User ID","type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"number","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"number","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"type":"object"},"ReactionRemovalResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"type":"object"},"ReactionRequest":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"format":"int32","type":"integer","x-stream-index":"002"},"type":{"maxLength":30,"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","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"],"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":{"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"],"type":"object"},"ReactivateUsersResponse":{"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"],"type":"object"},"Read":{"nullable":true,"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/UserObject","x-stream-index":"001"}},"required":["last_read","unread_messages"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"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":["audio_only","mode","quality"],"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"],"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"],"type":"object"},"RecordSettingsResponse":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"type":"object"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"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":"027"},"assigned_to":{"$ref":"#/components/schemas/UserObject","x-stream-index":"024"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"025"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"016"},"content_changed":{"type":"boolean","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/UserObject","x-stream-index":"023"},"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":"029"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"030"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"022"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"015"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"019"},"reviewed_by":{"type":"string","x-stream-index":"020"},"severity":{"format":"int32","type":"integer","x-stream-index":"018"},"status":{"type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"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":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"S3Request":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"type":"object"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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":{"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"}},"type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, -1 for descending, 1 for ascending","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"},"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"},"StartHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StartHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"playlist_url":{"type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"type":"object"},"StartRTMPBroadcastsRequest":{"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"],"type":"object"},"StartRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"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"],"type":"object"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopLiveRequest":{"nullable":true,"type":"object"},"StopLiveResponse":{"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"],"type":"object"},"StopRTMPBroadcastsRequest":{"nullable":true,"type":"object"},"StopRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopTranscriptionRequest":{"nullable":true,"type":"object"},"StopTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock"],"type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","x-stream-index":"007"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","x-stream-index":"008"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","x-stream-index":"006"},"item_id":{"type":"string","x-stream-index":"001"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["duration"],"type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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":"002"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"011"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"010"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"004"},"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":"009"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","description":"User is the user object","title":"User","x-stream-index":"007"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"006"}},"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/UserObject","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/Message","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":{"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"},"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/Read"},"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"},"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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"title":"string","type":"string","x-stream-index":"002"},"languages":{"description":"the languages to transcribe to","items":{"type":"string"},"maximum":2,"title":"array","type":"array","x-stream-index":"003"},"mode":{"description":"oneof=available disabled auto-on","enum":["available","disabled","auto-on"],"title":"string","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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"}},"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005"},"unbanned_by_id":{"type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"UnblockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"],"type":"object"},"UnmuteResponse":{"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"],"type":"object"},"UnpinRequest":{"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"],"type":"object"},"UnpinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"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":"004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"003"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"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":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.040"},"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.042"},"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.043"},"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"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.045"},"feeds_v2_region":{"type":"string","x-stream-index":"001.044"},"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"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.041"},"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_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_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"video_provider":{"enum":["agora","hms"],"type":"string","x-stream-index":"001.039"},"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":{"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateCallMembersRequest":{"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"}},"type":"object"},"UpdateCallMembersResponse":{"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"],"type":"object"},"UpdateCallRequest":{"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"}},"type":"object"},"UpdateCallResponse":{"description":"Represents 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":"Call","type":"object"},"UpdateCallTypeRequest":{"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"}},"type":"object"},"UpdateCallTypeResponse":{"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"],"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.025"},"blocklist":{"type":"string","x-stream-index":"009.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.023"},"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.018"},"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"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.025"},"blocklist":{"type":"string","x-stream-index":"003.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"description":"Represents custom chat 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"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"Command","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"type":"object"},"UpdateExternalStorageResponse":{"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"],"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":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"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"],"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"},"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","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":{"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"],"type":"object"},"UserBlock":{"nullable":true,"properties":{"blocked_by_user_id":{"type":"string","x-stream-index":"005"},"blocked_user_id":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"image":{"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"004"}},"required":["name","image","custom","roles"],"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/UserObject","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/UserObject","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"},"UserObject":{"description":"Represents chat user","properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"015"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"014"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","readOnly":true,"title":"Deactivated at","type":"number","x-stream-index":"012"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","readOnly":true,"title":"Deleted at","type":"number","x-stream-index":"011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"032"},"last_active":{"description":"Date of last activity","format":"date-time","readOnly":true,"title":"Last active","type":"number","x-stream-index":"010"},"online":{"description":"Whether a user online or not","readOnly":true,"title":"Online","type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"039"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"004"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"033"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"title":"User object","type":"object"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"type":"object"},"VelocityFilterConfig":{"properties":{"cascading_actions":{"type":"boolean","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules","cascading_actions"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"timeout":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["action","shadow_ban","ip_ban","cascading_threshold","cascading_action"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoResolution","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"VideoResolution":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"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":{"Option":{"$ref":"#/components/schemas/PollOption","x-stream-index":"003"},"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":"022"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"023"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"010"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_type":{"type":"string","x-stream-index":"006"},"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":"027"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"021"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"018"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"013"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"007"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"008"},"parent_id":{"type":"string","x-stream-index":"024"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"014"},"poll_vote":{"$ref":"#/components/schemas/PollVote","x-stream-index":"015"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"009"},"reason":{"type":"string","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"025"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"012"},"thread_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"016"},"user_id":{"type":"string","x-stream-index":"017"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"019"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WrappedUnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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"],"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":"v133.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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"description":"Successful response"},"400":{"content":{"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/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"Get Block list response"},"400":{"content":{"application/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/Response"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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"}}},"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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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":"Successful response"},"400":{"content":{"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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"}}},"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Command","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Command","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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/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/export_channels/{id}":{"get":{"description":"\n","operationId":"GetExportChannelsStatus","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/GetExportChannelsStatusResponse"}}},"description":"Successful response"},"400":{"content":{"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 status","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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":"Successful response"},"400":{"content":{"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","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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"description":"Successful response"},"400":{"content":{"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","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadMessageFlags\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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":"Successful response"},"400":{"content":{"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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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":"Successful response"},"400":{"content":{"application/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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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":"Successful response"},"400":{"content":{"application/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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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/threads":{"post":{"description":"Returns the list of threads for specific user\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"}}},"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Moderation v2 ban\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":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Moderation v2 check\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":"Moderation v2 check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Moderation v2 upsert configuration\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":"Moderation v2 upsert 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":{"type":"string","x-stream-index":"001"}}],"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":"Moderation v2 get configuration\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string","x-stream-index":"001"}}],"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":"Moderation v2 get configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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 configs","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Moderation v2 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":"Moderation v2 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 (hard limit of 100 templates)\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":"Moderation v2 query feed templates","tags":["product:moderation"]},"post":{"description":"Moderation v2 upsert feeds template\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":"Moderation v2 upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Query review queue items allows you to filter the moderation logs. This is used for building a moderation dashboard.\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/moderator_stats":{"get":{"description":"Moderation v2 moderator stats\n","operationId":"get_moderator_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModeratorStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 moderator stats","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 mute","tags":["product:moderation"]}},"/api/v2/moderation/queue_stats":{"get":{"description":"Moderation v2 queue stats\n","operationId":"get_queue_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 queue stats","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":"Moderation v2 get review queue item\n","operationId":"get_review_queue_item","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/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":"Moderation v2 get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Moderation v2 submit action\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":"Moderation v2 submit action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Moderation v2 unban\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":"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":"Moderation v2 unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Moderation V2 unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation V2 unmute a user","tags":["product:moderation"]}},"/api/v2/moderation/usage_stats":{"post":{"description":"Query usage stats\n","operationId":"query_usage_stats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Query usage stats","tags":["product:moderation"]}},"/api/v2/moderation/user_report":{"get":{"description":"Moderation v2 get user moderation report\n","operationId":"get_user_report","parameters":[{"in":"query","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"create_user_if_not_exists","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"include_user_mutes","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"include_user_blocks","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserModerationReportResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get user moderation report","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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"description":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCallStats\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"Call"},"400":{"content":{"application/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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- SendEvent\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"Successful response"},"400":{"content":{"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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- EndCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteUsers\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListRecordings\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":"Successful response"},"400":{"content":{"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}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n\nRequired permissions:\n- StartBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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":"Successful response"},"400":{"content":{"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartTranscription\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":"Successful response"},"400":{"content":{"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopRecording\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopTranscription\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListTranscriptions\n","operationId":"ListTranscriptions","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/ListTranscriptionsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCallPermissions\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteRecording\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteTranscription\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://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","notification_template"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionConfig":{"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"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"009"},"target_user_id":{"type":"string","x-stream-index":"010"},"type":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"type":"object"},"AppResponseFields":{"properties":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"039"},"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":"042"},"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"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"041"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"040"},"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_enabled":{"type":"boolean","x-stream-index":"043"},"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"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"video_provider":{"type":"string","x-stream-index":"038"},"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"],"type":"object"},"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":"021"},"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":"022"},"image_url":{"type":"string","x-stream-index":"011"},"latitude":{"format":"float","type":"number","x-stream-index":"018"},"longitude":{"format":"float","type":"number","x-stream-index":"019"},"og_scrape_url":{"type":"string","x-stream-index":"023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"024"},"pretext":{"type":"string","x-stream-index":"004"},"stopped_sharing":{"type":"boolean","x-stream-index":"020"},"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"],"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":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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"},"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":"005"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"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","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"003"},"type":{"description":"Block list type.","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":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"005"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","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"},"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"},"BodyguardConfig":{"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"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"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"},"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"},"CallEvent":{"nullable":true,"properties":{"category":{"type":"string","x-stream-index":"009"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"issue_tags":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"kind":{"type":"string","x-stream-index":"008"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal","kind"],"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"},"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"},"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"},"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"],"title":"CallRecording","type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"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"},"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"},"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":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"007"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"009"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"008"},"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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"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"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"title":"CallTranscription","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"},"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"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"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":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"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":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.025"},"blocklist":{"type":"string","x-stream-index":"001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.023"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.028"},"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"}},"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","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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.028"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"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"},"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"},"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":{"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","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","create-call","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-call","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-typing-events","set-channel-cooldown","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"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.028"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"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"},"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":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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":"007.001"},"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":"004"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"005"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"006"},"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":{"type":"string","x-stream-index":"005"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"test_mode":{"type":"boolean","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"004"},"recommended_action":{"type":"string","x-stream-index":"003"},"status":{"type":"string","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"title":"Response","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"},"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":["user_session_id","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"},"Config":{"properties":{"app_certificate":{"type":"string","x-stream-index":"002"},"app_id":{"type":"string","x-stream-index":"001"},"default_role":{"enum":["attendee","publisher","subscriber","admin"],"type":"string","x-stream-index":"003"},"role_map":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["app_id","app_certificate"],"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"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key","async","created_at","updated_at"],"type":"object"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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"},"type":{"description":"Block list type.","enum":["regex","domain","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"},"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":"017"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"018"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"022"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"023"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"024"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"019"},"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":"021"},"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":"016"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"015"},"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":"025"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"026"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"020"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"027"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.025"},"blocklist":{"type":"string","x-stream-index":"001.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.028"},"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"}},"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","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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"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":"004"},"position":{"format":"int32","type":"integer","x-stream-index":"003"},"text":{"description":"Option text","title":"string","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"}},"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"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"name":{"type":"string","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"007"},"recommended_action":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CustomCheckResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"008.001"},"id":{"type":"string","x-stream-index":"001"},"moderator_action":{"type":"string","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"002"},"report":{"additionalProperties":{},"type":"array","x-stream-index":"004"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"007"},"scored_at":{"format":"date-time","type":"number","x-stream-index":"005"},"status":{"type":"string","x-stream-index":"003"}},"required":["id","recommended_action","status","report","scored_at","duration"],"title":"Response","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":{"description":"Basic response information","nullable":true,"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"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"},"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"},"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.006"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.005"},"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"},"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"}},"required":["playlist_url"],"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"},"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"},"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":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.016"},"banned":{"type":"boolean","x-stream-index":"001.015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"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.022"},"language":{"type":"string","x-stream-index":"001.033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"001.024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.040"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"}},"required":["id","role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"description":"User response object","properties":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"001.003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.001.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.001.010"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001.006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.001.013"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.001.014"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"001.002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.001.007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible","ban_count","deleted_content_count"],"title":"UserResponse","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"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled","apns"],"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":25,"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"},"ExportChannelsResult":{"properties":{"path":{"description":"S3 path of result","title":"PathPrefix","type":"string","x-stream-index":"002"},"s3_bucket_name":{"description":"S3 bucket name result","title":"S3 bucket name","type":"string","x-stream-index":"003"},"url":{"description":"URL of result","title":"URL","type":"string","x-stream-index":"001"}},"required":["url"],"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"},"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":"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","notification_template","data_template","apn_template"],"type":"object"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"Flag2Response":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"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_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["user_id","entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"reason":{"maxLength":255,"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item_id":{"type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"title":"Response","type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"},"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"},"GetCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"title":"Response","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":"002.001"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.028"},"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"}},"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","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":{"description":"Basic response information","nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"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"},"GetExportChannelsStatusResponse":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.007.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Contains task error in case of failure","title":"Error","x-stream-index":"003"},"result":{"$ref":"#/components/schemas/ExportChannelsResult","description":"Contains task result in case of success","title":"ExportChannelsResult","x-stream-index":"002"},"status":{"description":"Task status","enum":["waiting","pending","running","completed","failed","canceled"],"title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"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.021"},"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.022"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"latitude":{"format":"float","type":"number","x-stream-index":"001.018"},"longitude":{"format":"float","type":"number","x-stream-index":"001.019"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.024"},"pretext":{"type":"string","x-stream-index":"001.004"},"stopped_sharing":{"type":"boolean","x-stream-index":"001.020"},"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"},"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"history":{"items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"type":"array","x-stream-index":"002"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"001"}},"required":["history","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":"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"},"GetUserModerationReportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_blocks":{"items":{"$ref":"#/components/schemas/UserBlock"},"type":"array","x-stream-index":"003"},"user_mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"002"}},"required":["user","user_mutes","user_blocks","duration"],"title":"Response","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"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"}},"required":["enabled"],"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"},"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":"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"},"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":{"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":{"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","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"},"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"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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"},"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":"011"},"before_message_send_failed":{"type":"boolean","x-stream-index":"045"},"cid":{"type":"string","x-stream-index":"027"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"043"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"039"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"012"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"mml":{"type":"string","x-stream-index":"005"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"parent_id":{"type":"string","x-stream-index":"018"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"050"},"pinned":{"type":"boolean","x-stream-index":"046"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"047"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"024"},"quoted_message_id":{"type":"string","x-stream-index":"023"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"021"},"shadowed":{"type":"boolean","x-stream-index":"035"},"show_in_channel":{"type":"boolean","x-stream-index":"020"},"silent":{"type":"boolean","x-stream-index":"044"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"026"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","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"},"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"},"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"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"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":"008"},"last_read_message_id":{"type":"string","x-stream-index":"009"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["cid","channel_id","channel_type","type","created_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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"020.002"},"user_id":{"type":"string","x-stream-index":"020.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":"021"},"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":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"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":"029"},"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":"027"},"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":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"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"},"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":"014"},"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":"034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"031"},"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":"032"},"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":"033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"018"},"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":"013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"016"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"026"},"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":"015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"030"},"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":"020"},"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":"023"},"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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"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.021"},"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.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"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.029"},"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.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"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"},"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.014"},"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.034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.031"},"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.032"},"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.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.036"},"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.019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.018"},"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.013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.016"},"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.026"},"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.015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.030"},"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.020"},"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.023"},"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","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"ModerationUsageStats":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"004"},"id":{"format":"int32","type":"integer","x-stream-index":"003"},"organization_id":{"format":"int32","type":"integer","x-stream-index":"005"},"reference_date":{"format":"date-time","type":"number","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"usage_amount":{"format":"int32","type":"integer","x-stream-index":"008"},"usage_type":{"type":"string","x-stream-index":"007"}},"required":["id","app_pk","organization_id","reference_date","usage_type","usage_amount","updated_at"],"type":"object"},"ModeratorStats":{"nullable":true,"properties":{"action_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"items_reviewed":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["id","items_reviewed","action_counts"],"type":"object"},"ModeratorStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"moderator_stats":{"items":{"$ref":"#/components/schemas/ModeratorStats"},"type":"array","x-stream-index":"001"}},"required":["moderator_stats","duration"],"title":"Response","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"},"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"043"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"026"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"011"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"027"},"online":{"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"031"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"032"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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"},"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"},"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"021"},"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"},"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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2"],"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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"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"},"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"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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"},"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":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"}},"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"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"templates":{"items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"type":"array","x-stream-index":"001"}},"required":["templates","duration"],"title":"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"},"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":{},"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/SortParamRequest"},"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":{"description":"Basic response information","nullable":true,"properties":{"configs":{"items":{"$ref":"#/components/schemas/ConfigResponse"},"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"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"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/SortParamRequest"},"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"logs":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"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"],"title":"Response","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"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"format":"int32","maximum":25,"minimum":1,"type":"integer","x-stream-index":"005"},"lock_duration":{"type":"integer","x-stream-index":"004"},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"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":{"description":"Basic response information","nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"title":"Response","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":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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"},"QueryUsageStatsRequest":{"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/SortParamRequest"},"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"},"QueryUsageStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"items":{"items":{"$ref":"#/components/schemas/ModerationUsageStats"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["items","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"},"QueueStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"avg_time_to_action":{"type":"integer","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"time_to_action_buckets":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"}},"required":["avg_time_to_action","time_to_action_buckets","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"},"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"},"ReactionRemovalResponse":{"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/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"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"},"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"},"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":"028"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"025"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"026"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"017"},"content_changed":{"type":"boolean","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"024"},"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":"030"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"031"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"027"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"023"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"016"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"020"},"reviewed_by":{"type":"string","x-stream-index":"021"},"severity":{"format":"int32","type":"integer","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"015"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"type":"array","x-stream-index":"020"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"018"},"completed_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","x-stream-index":"015"},"entity_creator_id":{"type":"string","x-stream-index":"016"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"021"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"022"},"flags":{"items":{"$ref":"#/components/schemas/Flag2Response"},"type":"array","x-stream-index":"019"},"id":{"type":"string","x-stream-index":"001"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"008"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"010"},"reviewed_by":{"type":"string","x-stream-index":"011"},"severity":{"format":"int32","type":"integer","x-stream-index":"013"},"status":{"type":"string","x-stream-index":"007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","bans","flags","actions"],"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":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"S3Request":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"type":"object"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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"},"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":"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":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartTranscriptionRequest","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,"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"},"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,"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,"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":{"enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock"],"type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","x-stream-index":"006"},"item_id":{"type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"013.002"},"user_id":{"type":"string","x-stream-index":"013.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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"},"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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"languages":{"description":"the languages to transcribe to","items":{"type":"string"},"maximum":2,"title":"array","type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"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"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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","x-stream-index":"005"},"unbanned_by_id":{"type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","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"},"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":"004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"003"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"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":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.040"},"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.042"},"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.043"},"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"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.045"},"feeds_v2_region":{"type":"string","x-stream-index":"001.044"},"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"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.041"},"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_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_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"video_provider":{"enum":["agora","hms"],"type":"string","x-stream-index":"001.039"},"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":{"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.025"},"blocklist":{"type":"string","x-stream-index":"009.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.023"},"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.018"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.028"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.025"},"blocklist":{"type":"string","x-stream-index":"003.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.028"},"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"}},"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","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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"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"},"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":"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"},"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"},"UpsertConfigRequest":{"nullable":true,"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"description":"Basic response information","nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"title":"Response","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":{"ban_expires":{"format":"date-time","type":"number","x-stream-index":"016"},"banned":{"type":"boolean","x-stream-index":"015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"040"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"type":"object"},"UserBlock":{"nullable":true,"properties":{"blocked_by_user_id":{"type":"string","x-stream-index":"005"},"blocked_user_id":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"002"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"005"}},"required":["id","name","image","custom","roles"],"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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"type":"object"},"VelocityFilterConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"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"],"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"},"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"}},"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"],"type":"object"},"VideoDimension":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoDimension","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"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":{"Option":{"$ref":"#/components/schemas/PollOptionResponseData","x-stream-index":"003"},"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":"021"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"022"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"009"},"channel_id":{"type":"string","x-stream-index":"004"},"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":"026"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"020"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"017"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"007"},"parent_id":{"type":"string","x-stream-index":"023"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"013"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"014"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"024"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"011"},"thread_id":{"type":"string","x-stream-index":"010"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"015"},"user_id":{"type":"string","x-stream-index":"016"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"018"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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":"v137.0.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","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/Response"}}},"description":"Response"},"400":{"content":{"application/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":{"description":"Block list 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 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"}}],"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/Response"}}},"description":"Response"},"400":{"content":{"application/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\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 campaign","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"}}],"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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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/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/export_channels/{id}":{"get":{"description":"\n","operationId":"GetExportChannelsStatus","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/GetExportChannelsStatusResponse"}}},"description":"Successful response"},"400":{"content":{"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 status","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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","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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.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","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","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\nRequired permissions:\n- ReadMessageFlags\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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":"ControllerNameQuerySegmentTargets","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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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"}}},"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"}}},"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":"Moderation v2 ban\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Moderation v2 check\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Moderation v2 upsert configuration\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 upsert 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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Response"},"400":{"content":{"application/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":"Moderation v2 get configuration\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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":"Response"},"400":{"content":{"application/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 configs","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Moderation v2 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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 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":"Response"},"400":{"content":{"application/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 (hard limit of 100 templates)\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 query feed templates","tags":["product:moderation"]},"post":{"description":"Moderation v2 upsert feeds template\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Query review queue items allows you to filter the moderation logs. This is used for building a moderation dashboard.\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":"Response"},"400":{"content":{"application/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/moderator_stats":{"get":{"description":"Moderation v2 moderator stats\n","operationId":"get_moderator_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModeratorStatsResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 moderator stats","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\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":"Moderation v2 mute","tags":["product:moderation"]}},"/api/v2/moderation/queue_stats":{"get":{"description":"Moderation v2 queue stats\n","operationId":"get_queue_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatsResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 queue stats","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":"Response"},"400":{"content":{"application/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":"Moderation v2 get review queue item\n","operationId":"get_review_queue_item","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/GetReviewQueueItemResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Moderation v2 submit action\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 submit action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Moderation v2 unban\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":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Moderation V2 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":"Moderation V2 unmute a user","tags":["product:moderation"]}},"/api/v2/moderation/usage_stats":{"post":{"description":"Query usage stats\n","operationId":"query_usage_stats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Query usage stats","tags":["product:moderation"]}},"/api/v2/moderation/user_report":{"get":{"description":"Moderation v2 get user moderation report\n","operationId":"get_user_report","parameters":[{"in":"query","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"create_user_if_not_exists","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"include_user_mutes","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"include_user_blocks","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserModerationReportResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get user moderation report","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/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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\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/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- ReadCallStats\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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- DeleteCall\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\nRequired permissions:\n- SendEvent\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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- EndCall\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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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\nRequired permissions:\n- MuteUsers\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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- ListRecordings\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}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StartClosedCaptions\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"}}],"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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\nRequired permissions:\n- StartTranscription\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"}}},"description":"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopClosedCaptions\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"}}],"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"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\nRequired permissions:\n- StopRecording\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\nRequired permissions:\n- StopTranscription\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"}}],"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\nRequired permissions:\n- ListTranscriptions\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- UpdateCallPermissions\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\nRequired permissions:\n- DeleteRecording\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\nRequired permissions:\n- DeleteTranscription\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\nRequired permissions:\n- ReadCall\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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/chat-openapi-clientside.json b/openapi/chat-openapi-clientside.json index 17afeda8..f893855e 100644 --- a/openapi/chat-openapi-clientside.json +++ b/openapi/chat-openapi-clientside.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"},"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":"string","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/UserObject","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"AgoraCall":{"properties":{"channel":{"type":"string","x-stream-index":"001"}},"required":["channel"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"moderation_enabled":{"type":"boolean","x-stream-index":"043"},"name":{"type":"string","x-stream-index":"001"},"video_provider":{"type":"string","x-stream-index":"038"}},"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"],"type":"object"},"Attachment":{"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"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"011"},"expires":{"format":"date-time","type":"string","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["shadow","created_at"],"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"},"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":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"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":"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"},"Call":{"properties":{"agora":{"$ref":"#/components/schemas/AgoraCall","x-stream-index":"005"},"hms":{"$ref":"#/components/schemas/HMSCall","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"provider":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"003"}},"required":["provider","id","type"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"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":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"string","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"string","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_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":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"truncated_by":{"$ref":"#/components/schemas/UserObject","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":{"description":"Channel configuration overrides","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"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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"},"title":"Grants","type":"object","x-stream-index":"002","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","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-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-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-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/UserObject","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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ChannelMember":{"nullable":true,"properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"017"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"016"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"021"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"014"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"009"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"010"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"008"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"022"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"title":"User ID","type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"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":"016"},"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":"017"},"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":"015"},"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","x-stream-index":"007"},"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"},"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/UserObject","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":"021"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"022"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"027"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"Config","x-stream-index":"017"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"024"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/UserObject","description":"Creator of the channel","title":"Created by","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"012"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"026"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"023"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"003"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"string","x-stream-index":"006"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"015"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"014"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"string","x-stream-index":"019"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"018"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"type":"string"},"title":"Own Capabilities","type":"array","x-stream-index":"025"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"020"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"Truncated At","type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"029"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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-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-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-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/UserObject","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-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/UserObject","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-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"},"ConnectRequest":{"properties":{"device":{"$ref":"#/components/schemas/DeviceFields","x-stream-index":"001.002"},"user_details":{"$ref":"#/components/schemas/UserObject","x-stream-index":"001.001"}},"required":["user_details"],"type":"object"},"CreateCallRequest":{"nullable":true,"properties":{"id":{"type":"string","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"type":{"enum":["audio","video"],"type":"string","x-stream-index":"003"}},"required":["type","id"],"type":"object"},"CreateCallResponse":{"nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"002.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"002.002"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"token":{"type":"string","x-stream-index":"002.001"}},"required":["token","duration"],"type":"object"},"CreateDeviceRequest":{"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"],"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":"004"},"position":{"format":"int32","type":"integer","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"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteChannelResponse":{"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"],"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":{"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"],"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"},"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"},"time":{"$ref":"#/components/schemas/Time","x-stream-index":"007"},"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"},"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":{"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"],"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/UserObject","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/UserObject","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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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":{"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"],"type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"004.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"004.002"}},"required":["type","created_at"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"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"},"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.009"}},"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":{"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"],"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"},"GetCallTokenRequest":{"nullable":true,"type":"object"},"GetCallTokenResponse":{"nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"001.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"001.002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"token":{"type":"string","x-stream-index":"001.001"}},"required":["token","duration"],"type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/Message"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"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"],"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":{"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"],"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"},"HMSCall":{"properties":{"room_id":{"type":"string","x-stream-index":"001"},"room_name":{"type":"string","x-stream-index":"002"}},"required":["room_id","room_name"],"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"},"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"],"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"}},"type":"object"},"HideChannelResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"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/UserObject","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-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/UserObject","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-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/UserObject","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-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":{"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":"011"},"before_message_send_failed":{"description":"Whether `before_message_send webhook` failed or not. Field is only accessible in push webhook","title":"Before Message Send Failed","type":"boolean","x-stream-docs-page-id":"before_message_send_webhook","x-stream-index":"045"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"027"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"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":"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":"043"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","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":"039"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Latest reactions","type":"array","x-stream-index":"012"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserObject"},"title":"Mentioned Users","type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"051"},"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":"005"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Own reactions","type":"array","x-stream-index":"013"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"018"},"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":"050"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"046"},"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":"047"},"pinned_by":{"$ref":"#/components/schemas/UserObject","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"024"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"023"},"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":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"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":"015"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"021"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"035"},"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":"020"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"044"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"004"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserObject"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"026"},"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":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/UserObject","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"010"}},"required":["id","text","html","type","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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-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/UserObject"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":"AI moderation response","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":"Moderation 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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"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"},"last_read_message_id":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"004.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"message.read","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"001.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"MessageReadEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"008"},"cid":{"type":"string","x-stream-index":"021"},"command":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"html":{"type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"029"},"id":{"type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"027"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"035"},"mml":{"type":"string","x-stream-index":"003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"010"},"parent_id":{"type":"string","x-stream-index":"014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"034"},"pinned":{"type":"boolean","x-stream-index":"031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"037"},"poll_id":{"type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"019"},"quoted_message_id":{"type":"string","x-stream-index":"018"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"016"},"shadowed":{"type":"boolean","x-stream-index":"026"},"show_in_channel":{"type":"boolean","x-stream-index":"015"},"silent":{"type":"boolean","x-stream-index":"030"},"text":{"type":"string","x-stream-index":"002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"020"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"023"},"user":{"$ref":"#/components/schemas/UserResponse","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"],"type":"object"},"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/UserObject"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessageWithChannelResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"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","channel"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","type":"object","x-stream-event-client-type":true,"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"},"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"},"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-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-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-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-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/UserObject","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-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/UserObject","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-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/UserObject","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-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/UserObject","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-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"},"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/UserObject","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-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-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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"014"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"042"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"027"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"012"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"025"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"type":"string","x-stream-index":"032"},"last_active":{"format":"date-time","type":"string","x-stream-index":"010"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"026"},"online":{"type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"033"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"028"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"031"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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/UserObject","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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.003.004"},"type":{"default":"poll.closed","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"type":"object"},"PollDeletedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.003.004"},"type":{"default":"poll.deleted","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"020"},"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":"018"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"created_by_id":{"type":"string","x-stream-index":"016"},"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_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":"015"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"019"},"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","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollUpdatedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.003.004"},"type":{"default":"poll.updated","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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/UserObject","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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_casted","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteChangedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_changed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteRemovedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_removed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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"},"QueryMembersPayload":{"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"],"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/SortParam"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"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"],"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":{"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"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"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":{"description":"Represents user reaction to a message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"description":"ID of a message user reacted to","title":"Message ID","type":"string","x-stream-index":"003"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"007"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"description":"ID of a user who reacted to a message","title":"User ID","type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"string","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"string","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionRemovalResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"type":"object"},"ReactionRequest":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"format":"int32","type":"integer","x-stream-index":"002"},"type":{"maxLength":30,"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"004"}},"required":["type"],"type":"object"},"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Read":{"nullable":true,"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/UserObject","x-stream-index":"001"}},"required":["last_read","unread_messages"],"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"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"027"},"assigned_to":{"$ref":"#/components/schemas/UserObject","x-stream-index":"024"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"025"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"016"},"content_changed":{"type":"boolean","x-stream-index":"028"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/UserObject","x-stream-index":"023"},"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":"029"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"030"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"022"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"015"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"019"},"reviewed_by":{"type":"string","x-stream-index":"020"},"severity":{"format":"int32","type":"integer","x-stream-index":"018"},"status":{"type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"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"],"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"},"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":{"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"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, -1 for descending, 1 for ascending","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"},"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":{"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"],"type":"object"},"SyncResponse":{"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"],"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":"002"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"011"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"010"},"last_thread_message_at":{"format":"date-time","type":"string","x-stream-index":"004"},"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":"009"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","description":"User is the user object","title":"User","x-stream-index":"007"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"006"}},"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/UserObject","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/Message","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":{"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"},"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/Read"},"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"Time":{"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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/UserObject","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-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/UserObject","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-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":{"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"],"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"},"UpdateChannelPartialRequest":{"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"},"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"},"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":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"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"],"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"},"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"},"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/UserObject","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/UserObject","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-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/UserObject","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","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/UserObject","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserObject":{"description":"Represents chat user","properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"015"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"014"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","readOnly":true,"title":"Deactivated at","type":"string","x-stream-index":"012"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","readOnly":true,"title":"Deleted at","type":"string","x-stream-index":"011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"032"},"last_active":{"description":"Date of last activity","format":"date-time","readOnly":true,"title":"Last active","type":"string","x-stream-index":"010"},"online":{"description":"Whether a user online or not","readOnly":true,"title":"Online","type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"039"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"004"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"033"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"title":"User object","type":"object"},"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/UserObject","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"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/UserObject","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-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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"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/UserObject","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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"VoteData":{"properties":{"Option":{"$ref":"#/components/schemas/PollOption","x-stream-index":"003"},"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSChannelEvent":{"description":"The discriminator object for all websocket channel events, it maps events' payload to the final type","discriminator":{"mapping":{"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"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"}]},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"*":"#/components/schemas/AnyEvent","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","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.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.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AnyEvent"},{"$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/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/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","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","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.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","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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/AnyEvent"},{"$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/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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"],"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":"v133.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":"Successful response"},"400":{"content":{"application/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"]}},"/calls":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/calls/{call_id}":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/channels":{"post":{"description":"Query channels with filter query\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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"}}},"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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/call":{"post":{"description":"Creates a call\n\nRequired permissions:\n- CreateCall\n- ReadChannel\n","operationId":"CreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 call","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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":"Successful response"},"400":{"content":{"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","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":"Successful response"},"400":{"content":{"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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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"]}},"/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"description":"Successful response"},"400":{"content":{"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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","type":"string","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- BanChannelMember\n- BanUser\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BanChannelMember\n- BanUser\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- FlagMessage\n- FlagUser\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","tags":["product:chat"]}},"/moderation/flags/message":{"get":{"description":"Find and filter message flags\n\nRequired permissions:\n- ReadMessageFlags\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":"Successful response"},"400":{"content":{"application/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.muted\n\nRequired permissions:\n- MuteUser\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteUser\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- MuteChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.deleted\n\nRequired permissions:\n- DeletePoll\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":"Successful response"},"400":{"content":{"application/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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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":"Successful response"},"400":{"content":{"application/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"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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"]}},"/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Successful response"},"400":{"content":{"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"]}},"/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/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://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"},"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":"string","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"},"AgoraCall":{"properties":{"channel":{"type":"string","x-stream-index":"001"}},"required":["channel"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"moderation_enabled":{"type":"boolean","x-stream-index":"043"},"name":{"type":"string","x-stream-index":"001"},"video_provider":{"type":"string","x-stream-index":"038"}},"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"],"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":"021"},"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":"022"},"image_url":{"type":"string","x-stream-index":"011"},"latitude":{"format":"float","type":"number","x-stream-index":"018"},"longitude":{"format":"float","type":"number","x-stream-index":"019"},"og_scrape_url":{"type":"string","x-stream-index":"023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"024"},"pretext":{"type":"string","x-stream-index":"004"},"stopped_sharing":{"type":"boolean","x-stream-index":"020"},"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"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"string","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"},"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"},"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"},"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"},"Call":{"properties":{"agora":{"$ref":"#/components/schemas/AgoraCall","x-stream-index":"005"},"hms":{"$ref":"#/components/schemas/HMSCall","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"provider":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"003"}},"required":["provider","id","type"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"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":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"string","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"string","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_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":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"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":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"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":{"description":"Channel configuration overrides","properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.028"},"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"}},"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","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-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-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-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-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-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":{"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","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-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","create-call","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-call","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-typing-events","set-channel-cooldown","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":"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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-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-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-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-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-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"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"}},"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"},"CreateCallRequest":{"nullable":true,"properties":{"id":{"type":"string","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"type":{"enum":["audio","video"],"type":"string","x-stream-index":"003"}},"required":["type","id"],"type":"object"},"CreateCallResponse":{"description":"Basic response information","nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"002.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"002.002"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"token":{"type":"string","x-stream-index":"002.001"}},"required":["token","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":"004"},"position":{"format":"int32","type":"integer","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"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"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"},"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"},"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"},"time":{"$ref":"#/components/schemas/Time","x-stream-index":"007"},"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":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"001.016"},"banned":{"type":"boolean","x-stream-index":"001.015"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.012"},"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.022"},"language":{"type":"string","x-stream-index":"001.033"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"001.024"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.040"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.034"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.008"}},"required":["id","role","custom","banned","online","ban_count","deleted_content_count"],"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"},"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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"004.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"004.002"}},"required":["type","created_at"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GetCallTokenRequest":{"nullable":true,"type":"object"},"GetCallTokenResponse":{"description":"Basic response information","nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"001.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"001.002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"token":{"type":"string","x-stream-index":"001.001"}},"required":["token","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.021"},"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.022"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"latitude":{"format":"float","type":"number","x-stream-index":"001.018"},"longitude":{"format":"float","type":"number","x-stream-index":"001.019"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.024"},"pretext":{"type":"string","x-stream-index":"001.004"},"stopped_sharing":{"type":"boolean","x-stream-index":"001.020"},"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"},"HMSCall":{"properties":{"room_id":{"type":"string","x-stream-index":"001"},"room_name":{"type":"string","x-stream-index":"002"}},"required":["room_id","room_name"],"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"},"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"],"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"}},"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"},"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-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-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-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":"011"},"before_message_send_failed":{"type":"boolean","x-stream-index":"045"},"cid":{"type":"string","x-stream-index":"027"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"043"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"039"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"012"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"051"},"mml":{"type":"string","x-stream-index":"005"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"parent_id":{"type":"string","x-stream-index":"018"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"050"},"pinned":{"type":"boolean","x-stream-index":"046"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"047"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"024"},"quoted_message_id":{"type":"string","x-stream-index":"023"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"021"},"shadowed":{"type":"boolean","x-stream-index":"035"},"show_in_channel":{"type":"boolean","x-stream-index":"020"},"silent":{"type":"boolean","x-stream-index":"044"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"026"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"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":"008"},"last_read_message_id":{"type":"string","x-stream-index":"009"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"005"},"type":{"default":"message.read","type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["cid","channel_id","channel_type","type","created_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":25,"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":"038"},"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":{"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":"021"},"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":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"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":"029"},"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":"027"},"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":"028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"035"},"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"},"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":"014"},"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":"034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"031"},"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":"032"},"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":"033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"018"},"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":"013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"016"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"026"},"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":"015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"030"},"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":"020"},"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":"023"},"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"],"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-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-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-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.021"},"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.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"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.029"},"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.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"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"},"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.014"},"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.034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.031"},"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.032"},"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.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.036"},"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.019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.018"},"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.013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.016"},"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.026"},"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.015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.030"},"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.020"},"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.023"},"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","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"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-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-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-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-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-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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"043"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"028"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"013"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"012"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"026"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","type":"string","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","type":"string","x-stream-index":"011"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"027"},"online":{"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"031"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"032"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.003.004"},"type":{"default":"poll.closed","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"type":"object"},"PollDeletedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.003.004"},"type":{"default":"poll.deleted","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"021"},"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"},"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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.003.004"},"type":{"default":"poll.updated","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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"},"PollVoteCastedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_casted","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteChangedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_changed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteRemovedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_removed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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"},"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"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionRemovalResponse":{"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/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"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-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"},"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"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"028"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"025"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"026"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"017"},"content_changed":{"type":"boolean","x-stream-index":"029"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"024"},"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":"030"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"031"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"027"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"023"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"016"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"020"},"reviewed_by":{"type":"string","x-stream-index":"021"},"severity":{"format":"int32","type":"integer","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"015"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"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"],"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"},"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"},"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"},"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-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"},"Time":{"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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-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-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"},"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"},"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":"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"},"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"},"User":{"properties":{"ban_expires":{"format":"date-time","type":"string","x-stream-index":"016"},"banned":{"type":"boolean","x-stream-index":"015"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"040"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"}},"required":["id","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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"VoteData":{"properties":{"Option":{"$ref":"#/components/schemas/PollOptionResponseData","x-stream-index":"003"},"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSChannelEvent":{"description":"The discriminator object for all websocket channel events, it maps events' payload to the final type","discriminator":{"mapping":{"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"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"}]},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"*":"#/components/schemas/AnyEvent","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","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.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.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AnyEvent"},{"$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/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/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","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","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.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","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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/AnyEvent"},{"$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/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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":"v137.0.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"]}},"/calls":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/calls/{call_id}":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/channels":{"post":{"description":"Query channels with filter query\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/call":{"post":{"description":"Creates a call\n\nRequired permissions:\n- CreateCall\n- ReadChannel\n","operationId":"CreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallResponse"}}},"description":"Response"},"400":{"content":{"application/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 call","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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","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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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"]}},"/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","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\nRequired permissions:\n- BanChannelMember\n- BanUser\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\nRequired permissions:\n- BanChannelMember\n- BanUser\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\nRequired permissions:\n- FlagMessage\n- FlagUser\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\nRequired permissions:\n- ReadMessageFlags\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.muted\n\nRequired permissions:\n- MuteUser\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteUser\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.deleted\n\nRequired permissions:\n- DeletePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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"]}},"/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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"]}},"/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/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://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 4f7ee383..857eb20f 100644 --- a/openapi/chat-openapi-clientside.yaml +++ b/openapi/chat-openapi-clientside.yaml @@ -110,7 +110,7 @@ components: type: string x-stream-index: "012" target_user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "013" target_user_id: type: string @@ -119,7 +119,7 @@ components: type: string x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "007" required: - id @@ -218,6 +218,8 @@ components: - moderation_enabled type: object Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. nullable: true properties: actions: @@ -243,7 +245,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "018" + x-stream-index: "021" fallback: type: string x-stream-index: "002" @@ -260,24 +262,35 @@ components: x-stream-index: "014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "019" + x-stream-index: "022" image_url: type: string x-stream-index: "011" + latitude: + format: float + type: number + x-stream-index: "018" + longitude: + format: float + type: number + x-stream-index: "019" og_scrape_url: type: string - x-stream-index: "020" + x-stream-index: "023" original_height: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "025" original_width: format: int32 type: integer - x-stream-index: "021" + x-stream-index: "024" pretext: type: string x-stream-index: "004" + stopped_sharing: + type: boolean + x-stream-index: "020" text: type: string x-stream-index: "010" @@ -331,7 +344,7 @@ components: type: string x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "011" expires: format: date-time @@ -344,7 +357,7 @@ components: type: boolean x-stream-index: "009" target: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "006" required: - shadow @@ -429,13 +442,17 @@ components: 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: @@ -774,7 +791,7 @@ components: $ref: '#/components/schemas/ChannelConfig' x-stream-index: "025" config_overrides: - $ref: '#/components/schemas/ChannelConfig' + $ref: '#/components/schemas/ConfigOverrides' x-stream-index: "026" cooldown: format: int32 @@ -785,7 +802,7 @@ components: type: string x-stream-index: "009" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "008" custom: additionalProperties: {} @@ -826,7 +843,7 @@ components: type: string x-stream-index: "027" truncated_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "015" type: type: string @@ -859,8 +876,10 @@ components: type: string x-stream-index: "009" commands: + description: List of commands that channel supports items: type: string + title: Commands type: array x-stream-index: "011" grants: @@ -972,13 +991,8 @@ components: items: type: string type: array - title: Grants type: object x-stream-index: "002" - x-stream-map: - description: List of grants modifiers that apply to a role - key: role - title: Grants mark_messages_pending: type: boolean x-stream-index: 001.002.015 @@ -1027,6 +1041,9 @@ components: search: type: boolean x-stream-index: 001.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.028 typing_events: type: boolean x-stream-index: 001.002.002 @@ -1063,6 +1080,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands type: object ChannelCreatedEvent: @@ -1224,7 +1242,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - clear_history @@ -1334,82 +1352,101 @@ components: 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: "017" + x-stream-index: "013" banned: description: Whether member is banned this channel or not title: Banned type: boolean - x-stream-index: "016" + x-stream-index: "012" channel_role: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "021" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "012" + x-stream-index: "009" custom: additionalProperties: {} type: object - x-stream-index: "006" + x-stream-index: "004" deleted_at: format: date-time type: string - x-stream-index: "014" + 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: "009" + 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: "010" + x-stream-index: "007" invited: description: Whether member was invited or not title: Invited type: boolean - x-stream-index: "008" + x-stream-index: "005" is_moderator: description: Whether member is channel moderator or not title: Is moderator type: boolean - x-stream-index: "007" + x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "022" + 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: "019" + x-stream-index: "014" status: type: string - x-stream-index: "011" + x-stream-index: "008" updated_at: description: Date/time of the last update format: date-time title: Updated at type: string - x-stream-index: "013" + x-stream-index: "010" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "005" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" user_id: title: User ID type: string - x-stream-index: "004" + x-stream-index: "001" required: - custom - created_at @@ -1421,8 +1458,11 @@ components: 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 @@ -1438,7 +1478,7 @@ components: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "016" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time @@ -1477,7 +1517,11 @@ components: x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "017" + 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)' @@ -1488,7 +1532,7 @@ components: - owner title: Role type: string - x-stream-index: "015" + x-stream-index: "017" shadow_banned: description: Whether member is shadow banned in this channel or not title: Shadow banned @@ -1539,30 +1583,30 @@ components: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "007" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "009" + x-stream-index: "004" expires: description: Date/time of mute expiration format: date-time title: Expires type: string - x-stream-index: "008" + x-stream-index: "003" updated_at: description: Date/time of the last update format: date-time title: Updated at type: string - x-stream-index: "010" + x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Owner of channel mute title: User - x-stream-index: "005" + x-stream-index: "001" required: - created_at - updated_at @@ -1585,6 +1629,47 @@ components: x-stream-event-client-type: true 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 + - create-call + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-call + - 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-typing-events + - set-channel-cooldown + - 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: @@ -1592,141 +1677,143 @@ components: description: Whether auto translation is enabled or not title: Auto translation type: boolean - x-stream-index: "021" + 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: "022" + x-stream-index: "018" blocked: description: Whether this channel is blocked by current user or not title: Blocked type: boolean - x-stream-index: "027" + x-stream-index: "023" cid: description: Channel CID (:) title: CID type: string - x-stream-index: "005" + x-stream-index: "003" config: $ref: '#/components/schemas/ChannelConfigWithInfo' description: Channel configuration - title: Config - x-stream-index: "017" + title: ChannelConfigWithInfo + x-stream-index: "013" cooldown: description: Cooldown period after sending each message format: int32 title: Cooldown type: integer - x-stream-index: "024" + x-stream-index: "020" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "008" + x-stream-index: "005" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Creator of the channel - title: Created by - x-stream-index: "011" + title: UserResponse + x-stream-index: "008" custom: additionalProperties: {} + description: Custom data for this object + title: Custom data type: object - x-stream-index: "030" + x-stream-index: "026" deleted_at: description: Date/time of deletion format: date-time title: Deleted at type: string - x-stream-index: "010" + x-stream-index: "007" disabled: type: boolean - x-stream-index: "013" + x-stream-index: "010" frozen: description: Whether channel is frozen or not title: Frozen type: boolean - x-stream-index: "012" + x-stream-index: "009" hidden: description: Whether this channel is hidden by current user or not title: Hidden type: boolean - x-stream-index: "026" + 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: "023" + x-stream-index: "019" id: description: Channel unique ID title: ID type: string - x-stream-index: "003" + 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: "006" + x-stream-index: "004" member_count: description: Number of members in the channel format: int32 title: Member count type: integer - x-stream-index: "015" + x-stream-index: "012" members: description: List of channel members (max 100) items: $ref: '#/components/schemas/ChannelMember' - title: Members + title: ChannelMembers type: array - x-stream-index: "014" + x-stream-index: "011" mute_expires_at: description: Date of mute expiration format: date-time title: Mute expires at type: string - x-stream-index: "019" + x-stream-index: "015" muted: description: Whether this channel is muted or not title: Muted type: boolean - x-stream-index: "018" + x-stream-index: "014" own_capabilities: description: List of channel capabilities of authenticated user items: - type: string - title: Own Capabilities + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability type: array - x-stream-index: "025" + x-stream-index: "021" team: description: Team the channel belongs to (multi-tenant only) title: Team type: string - x-stream-index: "020" + x-stream-index: "016" truncated_at: description: Date of the latest truncation of the channel format: date-time - title: Truncated At + title: UserResponse type: string - x-stream-index: "028" + x-stream-index: "024" truncated_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "029" + $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: "004" + x-stream-index: "002" updated_at: description: Date/time of the last update format: date-time title: Updated at type: string - x-stream-index: "009" + x-stream-index: "006" required: - id - type @@ -2006,7 +2093,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005.001" required: - type @@ -2040,7 +2127,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - cid @@ -2098,13 +2185,63 @@ components: - 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" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + required: + - grants + - commands + type: object ConnectRequest: properties: device: $ref: '#/components/schemas/DeviceFields' x-stream-index: "001.002" user_details: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001.001" required: - user_details @@ -2130,6 +2267,7 @@ components: - id type: object CreateCallResponse: + description: Basic response information nullable: true properties: agora_app_id: @@ -2153,8 +2291,10 @@ components: required: - token - duration + title: Response type: object CreateDeviceRequest: + description: Create device request nullable: true properties: id: @@ -2187,6 +2327,7 @@ components: required: - id - push_provider + title: CreateDeviceRequest type: object CreateGuestRequest: nullable: true @@ -2315,6 +2456,7 @@ components: - id type: object DeleteChannelResponse: + description: Basic response information nullable: true properties: channel: @@ -2327,6 +2469,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteChannelsRequest: nullable: true @@ -2382,6 +2525,7 @@ components: - status type: object DeleteMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -2395,6 +2539,7 @@ components: required: - message - duration + title: Response type: object Device: nullable: true @@ -2458,6 +2603,58 @@ components: - 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 EnrichedActivity: properties: actor: @@ -2575,7 +2772,98 @@ components: - activity_id - user_id type: object - EventRequest: + EntityCreator: + properties: + ban_count: + format: int32 + type: integer + x-stream-index: "002" + ban_expires: + format: date-time + type: string + x-stream-index: "001.016" + banned: + type: boolean + x-stream-index: "001.015" + created_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.007" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.005" + deactivated_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.013" + deleted_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.012" + 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.022" + language: + type: string + x-stream-index: "001.033" + last_active: + format: date-time + readOnly: true + type: string + x-stream-index: "001.010" + last_engaged_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.011" + online: + readOnly: true + type: boolean + x-stream-index: "001.021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "001.024" + revoke_tokens_issued_before: + format: date-time + type: string + x-stream-index: "001.040" + role: + type: string + x-stream-index: "001.004" + teams: + items: + type: string + type: array + x-stream-index: "001.034" + updated_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.008" + required: + - id + - role + - custom + - banned + - online + - ban_count + - deleted_content_count + type: object + EventRequest: properties: custom: additionalProperties: {} @@ -2591,6 +2879,7 @@ components: - type type: object EventResponse: + description: Basic response information nullable: true properties: duration: @@ -2604,6 +2893,7 @@ components: required: - event - duration + title: Response type: object Field: nullable: true @@ -2746,7 +3036,7 @@ components: type: string x-stream-index: "007" target_user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: Flagged user title: User x-stream-index: "010" @@ -2757,7 +3047,7 @@ components: type: string x-stream-index: "012" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: User who flagged a message or a user title: User x-stream-index: "006" @@ -2818,7 +3108,7 @@ components: type: string x-stream-index: "018" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "006" required: - entity_type @@ -2901,6 +3191,7 @@ components: x-stream-index: "002" type: object FlagResponse: + description: Basic response information nullable: true properties: duration: @@ -2917,6 +3208,7 @@ components: required: - review_queue_item_id - duration + title: Response type: object FlagUpdatedEvent: nullable: true @@ -2979,7 +3271,7 @@ components: x-stream-index: "001.010" devices: items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' type: array x-stream-index: "004" id: @@ -3077,6 +3369,7 @@ components: - blocked_user_ids type: object GetApplicationResponse: + description: Basic response information nullable: true properties: app: @@ -3090,6 +3383,7 @@ components: required: - app - duration + title: Response type: object GetBlockedUsersResponse: nullable: true @@ -3114,6 +3408,7 @@ components: nullable: true type: object GetCallTokenResponse: + description: Basic response information nullable: true properties: agora_app_id: @@ -3134,6 +3429,7 @@ components: required: - token - duration + title: Response type: object GetManyMessagesResponse: nullable: true @@ -3144,7 +3440,7 @@ components: messages: description: List of messages items: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' title: Messages type: array x-stream-index: "001.001" @@ -3153,6 +3449,7 @@ components: - duration type: object GetMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -3171,6 +3468,7 @@ components: required: - message - duration + title: Response type: object GetOGResponse: nullable: true @@ -3204,7 +3502,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "001.018" + x-stream-index: "001.021" duration: type: string x-stream-index: "002.001" @@ -3224,28 +3522,39 @@ components: x-stream-index: "001.014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "001.019" + x-stream-index: "001.022" image_url: description: URL of detected image title: Image URL type: string x-stream-index: "001.011" + latitude: + format: float + type: number + x-stream-index: "001.018" + longitude: + format: float + type: number + x-stream-index: "001.019" og_scrape_url: description: extracted url from the text title: OG Scrape URL type: string - x-stream-index: "001.020" + x-stream-index: "001.023" original_height: format: int32 type: integer - x-stream-index: "001.022" + x-stream-index: "001.025" original_width: format: int32 type: integer - x-stream-index: "001.021" + x-stream-index: "001.024" pretext: type: string x-stream-index: "001.004" + stopped_sharing: + type: boolean + x-stream-index: "001.020" text: description: og:description title: Text @@ -3295,6 +3604,7 @@ components: - duration type: object GetRepliesResponse: + description: Basic response information nullable: true properties: duration: @@ -3310,6 +3620,7 @@ components: required: - messages - duration + title: Response type: object GetThreadResponse: nullable: true @@ -3377,6 +3688,7 @@ components: x-stream-index: "001" type: object HideChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -3386,6 +3698,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object ImageData: properties: @@ -3543,25 +3856,30 @@ components: 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 ListDevicesResponse: + description: List devices response nullable: true properties: devices: description: List of devices items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "001" @@ -3571,6 +3889,7 @@ components: required: - devices - duration + title: ListDevicesResponse type: object MarkChannelsReadRequest: nullable: true @@ -3654,7 +3973,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005.001" required: - type @@ -3690,7 +4009,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -3729,7 +4048,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -3762,38 +4081,23 @@ components: - duration type: object Message: - 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: "011" before_message_send_failed: - description: Whether `before_message_send webhook` failed or not. Field - is only accessible in push webhook - title: Before Message Send Failed type: boolean - x-stream-docs-page-id: before_message_send_webhook x-stream-index: "045" cid: - description: Channel unique identifier in : format - title: Channel CID type: string x-stream-index: "027" command: - description: Contains provided slash command - title: Command type: string - x-stream-docs-page-id: custom_commands_webhook x-stream-index: "006" created_at: - description: Date/time of creation format: date-time - title: Created at type: string x-stream-index: "029" custom: @@ -3801,9 +4105,7 @@ components: type: object x-stream-index: "033" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: string x-stream-index: "032" deleted_reply_count: @@ -3811,23 +4113,14 @@ components: type: integer x-stream-index: "022" 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: "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: "043" id: - description: Message ID is unique string identifier of the message - title: ID type: string x-stream-index: "002" image_labels: @@ -3835,22 +4128,16 @@ components: items: type: string type: array - description: Contains image moderation information - title: Image moderation labels type: object x-stream-index: "039" latest_reactions: - description: List of 10 latest reactions to this message items: $ref: '#/components/schemas/Reaction' - title: Latest reactions type: array x-stream-index: "012" mentioned_users: - description: List of mentioned users items: - $ref: '#/components/schemas/UserObject' - title: Mentioned Users + $ref: '#/components/schemas/User' type: array x-stream-index: "042" message_text_updated_at: @@ -3858,77 +4145,46 @@ components: type: string x-stream-index: "051" 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: "005" own_reactions: - description: List of 10 latest reactions of authenticated user to this message items: $ref: '#/components/schemas/Reaction' - title: Own reactions type: array x-stream-index: "013" parent_id: - description: ID of parent message (thread) - title: Parent message ID type: string - x-stream-docs-page-id: threads x-stream-index: "018" 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: "050" pinned: - description: Whether message is pinned or not - title: Pinned type: boolean - x-stream-docs-page-id: pinned_messages x-stream-index: "046" 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: "047" pinned_by: - $ref: '#/components/schemas/UserObject' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages + $ref: '#/components/schemas/User' x-stream-index: "049" poll: $ref: '#/components/schemas/Poll' x-stream-index: "053" poll_id: - description: Identifier of the poll to include in the message - title: Poll ID type: string x-stream-index: "052" quoted_message: $ref: '#/components/schemas/Message' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message x-stream-index: "024" quoted_message_id: - title: ID of quoted message type: string - x-stream-docs-page-id: threads#quote-message x-stream-index: "023" 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: "014" reaction_groups: @@ -3940,70 +4196,38 @@ components: 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: "015" reply_count: - description: Number of replies to this message format: int32 - title: Reply count type: integer x-stream-index: "021" shadowed: - description: Whether the message was shadowed or not - title: Shadowed type: boolean - x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "035" 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: "020" silent: - description: Whether message is silent or not - title: Silent type: boolean x-stream-index: "044" text: - description: Text of the message. Should be empty if `mml` is provided - title: Text type: string x-stream-index: "004" thread_participants: - description: List of users who participate in thread items: - $ref: '#/components/schemas/UserObject' - title: Thread participants + $ref: '#/components/schemas/User' type: array - x-stream-docs-page-id: threads#quote-message x-stream-index: "026" 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: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: string x-stream-index: "030" user: - $ref: '#/components/schemas/UserObject' - description: Sender of the message. Required when using server-side API - title: User object + $ref: '#/components/schemas/User' x-stream-index: "010" required: - id @@ -4026,9 +4250,7 @@ components: - mentioned_users - silent - pinned - title: Message type: object - x-stream-docs-page-id: send_message MessageActionRequest: nullable: true properties: @@ -4108,7 +4330,7 @@ components: x-stream-index: "005.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -4116,7 +4338,7 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - hard_delete @@ -4203,7 +4425,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "002.002" type: @@ -4211,7 +4433,7 @@ components: type: string x-stream-index: "005.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004" required: - cid @@ -4233,7 +4455,7 @@ components: ai_moderation_response: $ref: '#/components/schemas/ModerationResponse' description: Response from AI moderation - title: AI moderation response + title: ModerationResponse x-stream-index: "007" blocked_word: description: Word that was blocked @@ -4264,7 +4486,7 @@ components: moderation_thresholds: $ref: '#/components/schemas/Thresholds' description: Thresholds for AI moderation - title: Moderation thresholds + title: Thresholds x-stream-index: "006" updated_at: description: Date/time of the last update @@ -4315,7 +4537,7 @@ components: x-stream-index: "006.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -4323,7 +4545,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" watcher_count: format: int32 @@ -4347,44 +4569,40 @@ components: properties: channel_id: type: string - x-stream-index: "002.002" + x-stream-index: "003" channel_type: type: string - x-stream-index: "002.003" + x-stream-index: "004" cid: type: string - x-stream-index: "002.001" + x-stream-index: "002" created_at: format: date-time type: string - x-stream-index: "005.002" + x-stream-index: "008" last_read_message_id: type: string - x-stream-index: "006" + x-stream-index: "009" team: type: string - x-stream-index: "004.001" + x-stream-index: "006" thread: $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "003.001" + x-stream-index: "005" type: default: message.read type: string - x-stream-index: "005.001" + x-stream-index: "007" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "001.001" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" required: - cid - channel_id - channel_type - type - created_at - title: MessageReadEvent type: object - x-stream-event-client-type: true - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent MessageRequest: properties: attachments: @@ -4448,20 +4666,31 @@ components: 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 : format + title: Channel CID type: string x-stream-index: "021" 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: "022" custom: @@ -4469,7 +4698,9 @@ components: type: object x-stream-index: "025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: string x-stream-index: "024" deleted_reply_count: @@ -4477,14 +4708,23 @@ components: type: integer x-stream-index: "017" 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: "029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001" image_labels: @@ -4492,16 +4732,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "027" 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: "028" message_text_updated_at: @@ -4509,46 +4755,77 @@ components: type: string x-stream-index: "035" 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" 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: "014" 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: "034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "031" 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: "032" 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: "033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "036" quoted_message: $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message x-stream-index: "019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "018" 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: @@ -4560,38 +4837,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "016" shadowed: + description: Whether the message was shadowed or not + title: Shadowed type: boolean + x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "026" 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: "015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "030" 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: "020" 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: "023" 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 @@ -4614,7 +4923,9 @@ components: - mentioned_users - silent - pinned + title: Message type: object + x-stream-docs-page-id: send_message MessageUnblockedEvent: properties: cid: @@ -4629,7 +4940,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "002.002" type: @@ -4637,7 +4948,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - cid @@ -4671,7 +4982,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -4679,7 +4990,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -4724,7 +5035,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -4732,7 +5043,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -4746,23 +5057,36 @@ components: 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.021" 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.022" custom: @@ -4770,7 +5094,9 @@ components: type: object x-stream-index: "001.025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: string x-stream-index: "001.024" deleted_reply_count: @@ -4778,14 +5104,23 @@ components: type: integer x-stream-index: "001.017" 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.029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001.001" image_labels: @@ -4793,16 +5128,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "001.027" 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.028" message_text_updated_at: @@ -4810,46 +5151,77 @@ components: type: string x-stream-index: "001.035" 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" 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.014" 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.034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "001.031" 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.032" 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.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "001.036" 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.019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "001.018" 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: @@ -4861,38 +5233,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "001.016" 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.026" 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.015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "001.030" 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.020" 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.023" 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 @@ -4916,7 +5320,9 @@ components: - silent - pinned - channel + title: Message type: object + x-stream-docs-page-id: send_message ModerationCustomActionEvent: properties: created_at: @@ -4934,7 +5340,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -4961,7 +5367,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -4988,7 +5394,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -5310,7 +5716,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -5354,7 +5760,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -5398,7 +5804,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -5458,7 +5864,7 @@ components: type: integer x-stream-index: "008" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -5511,6 +5917,9 @@ components: team: type: string x-stream-index: "002.001" + thread_id: + type: string + x-stream-index: "013" total_unread_count: format: int32 type: integer @@ -5536,7 +5945,7 @@ components: type: integer x-stream-index: "011" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -5654,7 +6063,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -5703,17 +6112,17 @@ components: properties: banned: type: boolean - x-stream-index: "014" + x-stream-index: "015" blocked_user_ids: items: type: string type: array - x-stream-index: "042" + x-stream-index: "043" channel_mutes: items: $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "027" + x-stream-index: "028" created_at: format: date-time type: string @@ -5725,48 +6134,52 @@ components: deactivated_at: format: date-time type: string - x-stream-index: "012" + x-stream-index: "013" deleted_at: format: date-time type: string - x-stream-index: "011" + x-stream-index: "012" devices: items: $ref: '#/components/schemas/Device' type: array - x-stream-index: "025" + x-stream-index: "026" id: type: string x-stream-index: "003" invisible: type: boolean - x-stream-index: "021" + x-stream-index: "022" language: type: string - x-stream-index: "032" + x-stream-index: "033" last_active: format: date-time type: string x-stream-index: "010" + last_engaged_at: + format: date-time + type: string + x-stream-index: "011" latest_hidden_channels: items: type: string type: array - x-stream-index: "034" + x-stream-index: "035" mutes: items: $ref: '#/components/schemas/UserMute' type: array - x-stream-index: "026" + x-stream-index: "027" online: type: boolean - x-stream-index: "020" + x-stream-index: "021" privacy_settings: $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" + x-stream-index: "025" push_notifications: $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" + x-stream-index: "024" role: type: string x-stream-index: "004" @@ -5774,23 +6187,23 @@ components: items: type: string type: array - x-stream-index: "033" + x-stream-index: "034" total_unread_count: format: int32 type: integer - x-stream-index: "029" + x-stream-index: "030" unread_channels: format: int32 type: integer - x-stream-index: "030" + x-stream-index: "031" unread_count: format: int32 type: integer - x-stream-index: "028" + x-stream-index: "029" unread_threads: format: int32 type: integer - x-stream-index: "031" + x-stream-index: "032" updated_at: format: date-time type: string @@ -5845,7 +6258,7 @@ components: x-stream-index: "001.010" devices: items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "004" @@ -5990,7 +6403,7 @@ components: type: string x-stream-index: "021" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "020" created_by_id: type: string @@ -6231,7 +6644,7 @@ components: additionalProperties: {} type: object writeOnly: true - x-stream-index: "020" + x-stream-index: "021" allow_answers: type: boolean x-stream-index: "008" @@ -6245,13 +6658,13 @@ components: created_at: format: date-time type: string - x-stream-index: "018" + x-stream-index: "019" created_by: $ref: '#/components/schemas/UserResponse' - x-stream-index: "017" + x-stream-index: "018" created_by_id: type: string - x-stream-index: "016" + x-stream-index: "017" description: type: string x-stream-index: "003" @@ -6264,6 +6677,11 @@ components: 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: @@ -6287,11 +6705,11 @@ components: items: $ref: '#/components/schemas/PollVoteResponseData' type: array - x-stream-index: "015" + x-stream-index: "016" updated_at: format: date-time type: string - x-stream-index: "019" + x-stream-index: "020" vote_count: format: int32 type: integer @@ -6318,6 +6736,7 @@ components: - answers_count - vote_counts_by_option - latest_votes_by_option + - latest_answers - own_votes - created_by_id - created_at @@ -6378,7 +6797,7 @@ components: type: string x-stream-index: "011" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "009" user_id: type: string @@ -6745,6 +7164,7 @@ components: title: Channels list type: object QueryMembersPayload: + description: Client request properties: filter_conditions: additionalProperties: {} @@ -6783,6 +7203,7 @@ components: required: - type - filter_conditions + title: ClientRequest type: object QueryMessageFlagsPayload: properties: @@ -6808,12 +7229,13 @@ components: x-stream-index: "002" sort: items: - $ref: '#/components/schemas/SortParam' + $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: @@ -6831,6 +7253,7 @@ components: required: - flags - duration + title: QueryMessageFlagsResponse type: object QueryPollVotesRequest: nullable: true @@ -6943,6 +7366,7 @@ components: x-stream-index: "003" type: object QueryReactionsResponse: + description: Basic response information properties: duration: description: Duration of the request in milliseconds @@ -6963,6 +7387,7 @@ components: required: - reactions - duration + title: Response type: object QueryThreadsRequest: nullable: true @@ -7084,14 +7509,11 @@ components: - duration type: object Reaction: - description: Represents user reaction to a message nullable: true properties: created_at: - description: Date/time of creation format: date-time readOnly: true - title: Created at type: string x-stream-index: "008" custom: @@ -7099,35 +7521,25 @@ components: type: object x-stream-index: "010" message_id: - description: ID of a message user reacted to - title: Message ID type: string x-stream-index: "003" score: - description: Reaction score. If not specified reaction has score of 1 format: int32 - title: Score type: integer x-stream-index: "007" type: - description: The type of reaction (e.g. 'like', 'laugh', 'wow') maxLength: 30 - title: Type type: string x-stream-index: "006" updated_at: - description: Date/time of the last update format: date-time readOnly: true - title: Updated at type: string x-stream-index: "009" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005" user_id: - description: ID of a user who reacted to a message - title: User ID type: string x-stream-index: "004" required: @@ -7137,9 +7549,7 @@ components: - created_at - updated_at - custom - title: Reaction type: object - x-stream-docs-page-id: send_reaction ReactionDeletedEvent: properties: channel_id: @@ -7166,7 +7576,7 @@ components: x-stream-index: "005.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -7174,7 +7584,7 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - cid @@ -7188,22 +7598,38 @@ components: 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: @@ -7211,6 +7637,7 @@ components: - sum_scores - first_reaction_at - last_reaction_at + title: ReactionGroupResponse type: object ReactionNewEvent: properties: @@ -7238,7 +7665,7 @@ components: x-stream-index: "005.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -7246,7 +7673,7 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - cid @@ -7260,6 +7687,7 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent ReactionRemovalResponse: + description: Basic response information nullable: true properties: duration: @@ -7275,11 +7703,15 @@ components: x-stream-index: "002" required: - duration + title: Response type: object 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: @@ -7287,20 +7719,28 @@ components: 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: @@ -7386,7 +7826,7 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - message @@ -7401,27 +7841,6 @@ components: x-stream-event-client-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - Read: - nullable: true - 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/UserObject' - x-stream-index: "001" - required: - - last_read - - unread_messages - type: object ReadReceipts: properties: enabled: @@ -7460,6 +7879,7 @@ components: - unread_messages type: object Response: + description: Basic response information nullable: true properties: duration: @@ -7469,6 +7889,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object ReviewQueueItem: properties: @@ -7476,28 +7897,28 @@ components: items: $ref: '#/components/schemas/ActionLog' type: array - x-stream-index: "027" + x-stream-index: "028" assigned_to: - $ref: '#/components/schemas/UserObject' - x-stream-index: "024" + $ref: '#/components/schemas/User' + x-stream-index: "025" bans: items: $ref: '#/components/schemas/Ban' type: array - x-stream-index: "025" + x-stream-index: "026" completed_at: $ref: '#/components/schemas/NullTime' - x-stream-index: "016" + x-stream-index: "017" content_changed: type: boolean - x-stream-index: "028" + x-stream-index: "029" created_at: format: date-time type: string x-stream-index: "004" entity_creator: - $ref: '#/components/schemas/UserObject' - x-stream-index: "023" + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "024" entity_id: type: string x-stream-index: "007" @@ -7506,15 +7927,15 @@ components: x-stream-index: "006" feeds_v2_activity: $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "029" + x-stream-index: "030" feeds_v2_reaction: $ref: '#/components/schemas/Reaction' - x-stream-index: "030" + x-stream-index: "031" flags: items: $ref: '#/components/schemas/Flag2' type: array - x-stream-index: "026" + x-stream-index: "027" has_image: type: boolean x-stream-index: "011" @@ -7531,10 +7952,10 @@ components: items: type: string type: array - x-stream-index: "017" + x-stream-index: "018" message: $ref: '#/components/schemas/Message' - x-stream-index: "022" + x-stream-index: "023" moderation_payload: $ref: '#/components/schemas/ModerationPayload' x-stream-index: "009" @@ -7543,19 +7964,24 @@ components: x-stream-index: "010" recommended_action: type: string - x-stream-index: "015" + x-stream-index: "016" reviewed_at: $ref: '#/components/schemas/NullTime' - x-stream-index: "019" + x-stream-index: "020" reviewed_by: type: string - x-stream-index: "020" + x-stream-index: "021" severity: format: int32 type: integer - x-stream-index: "018" + x-stream-index: "019" status: type: string + x-stream-index: "015" + teams: + items: + type: string + type: array x-stream-index: "014" updated_at: format: date-time @@ -7571,6 +7997,7 @@ components: - has_image - has_video - has_text + - teams - status - recommended_action - completed_at @@ -7767,7 +8194,7 @@ components: $ref: '#/components/schemas/UserResponse' x-stream-index: "001.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: type: string @@ -8003,6 +8430,7 @@ components: - reaction type: object SendReactionResponse: + description: Basic response information nullable: true properties: duration: @@ -8020,11 +8448,13 @@ components: - message - reaction - duration + title: Response type: object ShowChannelRequest: nullable: true type: object ShowChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -8034,21 +8464,7 @@ components: x-stream-index: "001.001" required: - duration - type: object - SortParam: - nullable: true - properties: - direction: - description: Direction of sorting, -1 for descending, 1 for ascending - 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" + title: Response type: object SortParamRequest: nullable: true @@ -8067,6 +8483,7 @@ components: x-stream-index: "001" type: object SyncRequest: + description: Sync request nullable: true properties: channel_cids: @@ -8087,8 +8504,10 @@ components: required: - channel_cids - last_sync_at + title: SyncRequest type: object SyncResponse: + description: Sync response nullable: true properties: duration: @@ -8113,6 +8532,7 @@ components: required: - events - duration + title: SyncResponse type: object ThreadParticipant: description: Represents a user that is participating in a thread. @@ -8122,49 +8542,49 @@ components: format: int32 readOnly: true type: integer - x-stream-index: "002" + x-stream-index: "001" channel_cid: type: string - x-stream-index: "003" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "008" + x-stream-index: "007" custom: additionalProperties: {} type: object - x-stream-index: "011" + x-stream-index: "010" last_read_at: format: date-time type: string - x-stream-index: "010" + x-stream-index: "009" last_thread_message_at: format: date-time type: string - x-stream-index: "004" + 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: "009" + x-stream-index: "008" thread_id: description: Thead ID is unique string identifier of the thread title: ID type: string - x-stream-index: "005" + x-stream-index: "004" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: User is the user object title: User - x-stream-index: "007" + x-stream-index: "006" user_id: description: User ID is unique string identifier of the user title: User ID type: string - x-stream-index: "006" + x-stream-index: "005" required: - app_pk - channel_cid @@ -8198,7 +8618,7 @@ components: type: string x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Created By User title: User x-stream-index: "006" @@ -8226,7 +8646,7 @@ components: type: string x-stream-index: "011" parent_message: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' description: Parent Message title: Message x-stream-index: "004" @@ -8275,6 +8695,7 @@ components: - custom type: object ThreadStateResponse: + nullable: true properties: active_participant_count: description: Active Participant Count @@ -8349,7 +8770,7 @@ components: x-stream-index: "001.008" read: items: - $ref: '#/components/schemas/Read' + $ref: '#/components/schemas/ReadStateResponse' type: array x-stream-index: "003" reply_count: @@ -8409,7 +8830,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - cid @@ -8423,16 +8844,24 @@ components: 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 Time: type: object @@ -8587,7 +9016,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - cid @@ -8623,7 +9052,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - cid @@ -8674,6 +9103,7 @@ components: x-stream-index: "001.003" type: object UnmuteResponse: + description: Basic response information nullable: true properties: duration: @@ -8688,6 +9118,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object UnmuteUserRequest: nullable: true @@ -8779,6 +9210,7 @@ components: type: string type: array x-stream-index: "002.002" + title: UpdateChannelPartialRequest type: object UpdateChannelPartialResponse: nullable: true @@ -8924,6 +9356,35 @@ components: - members - duration 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: @@ -8990,6 +9451,7 @@ components: - message type: object UpdateMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -9008,6 +9470,7 @@ components: required: - message - duration + title: Response type: object UpdatePollOptionRequest: nullable: true @@ -9177,61 +9640,142 @@ components: 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: + 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 + User: + properties: + ban_expires: + format: date-time + type: string + x-stream-index: "016" + banned: + type: boolean + x-stream-index: "015" + created_at: + format: date-time + readOnly: true + type: string + x-stream-index: "007" + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + deactivated_at: + format: date-time + readOnly: true + type: string + x-stream-index: "013" + deleted_at: + format: date-time + readOnly: true + type: string + x-stream-index: "012" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "022" + language: + type: string + x-stream-index: "033" + last_active: + format: date-time + readOnly: true + type: string + x-stream-index: "010" + last_engaged_at: + format: date-time + readOnly: true + type: string + x-stream-index: "011" + online: + readOnly: true + type: boolean + x-stream-index: "021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "024" + revoke_tokens_issued_before: + format: date-time + type: string + x-stream-index: "040" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "034" + updated_at: + format: date-time + readOnly: true 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 + x-stream-index: "008" required: - - users - - membership_deletion_task_id - - duration + - id + - role + - custom + - banned + - online type: object UserBannedEvent: properties: @@ -9249,7 +9793,7 @@ components: type: string x-stream-index: "008.002" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" expiration: format: date-time @@ -9269,7 +9813,7 @@ components: type: string x-stream-index: "008.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "007.001" required: - created_by @@ -9291,14 +9835,14 @@ components: type: string x-stream-index: "003.002" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" type: default: user.deactivated type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - created_by @@ -9329,7 +9873,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001.001" required: - type @@ -9440,7 +9984,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -9466,7 +10010,7 @@ components: type: string x-stream-index: "008" target: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: User who's muted title: Target x-stream-index: "007" @@ -9477,7 +10021,7 @@ components: type: string x-stream-index: "010" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: Owner of channel mute title: User x-stream-index: "005" @@ -9529,7 +10073,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -9539,110 +10083,6 @@ components: x-stream-event-client-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - UserObject: - description: Represents chat user - properties: - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: string - x-stream-index: "015" - banned: - description: Whether a user is banned or not - title: Banned - type: boolean - x-stream-index: "014" - created_at: - description: Date/time of creation - format: date-time - readOnly: true - title: Created at - type: string - x-stream-index: "007" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - deactivated_at: - description: Date of deactivation - format: date-time - readOnly: true - title: Deactivated at - type: string - x-stream-index: "012" - deleted_at: - description: Date/time of deletion - format: date-time - readOnly: true - title: Deleted at - type: string - x-stream-index: "011" - id: - description: Unique user identifier - title: ID - type: string - x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "021" - language: - description: Preferred language of a user - title: Language - type: string - x-stream-index: "032" - last_active: - description: Date of last activity - format: date-time - readOnly: true - title: Last active - type: string - x-stream-index: "010" - online: - description: Whether a user online or not - readOnly: true - title: Online - type: boolean - x-stream-index: "020" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" - push_notifications: - $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" - revoke_tokens_issued_before: - description: Revocation date for tokens - format: date-time - title: Revoke tokens issued before - type: string - x-stream-index: "039" - role: - description: Determines the set of user permissions - title: Role - type: string - x-stream-index: "004" - teams: - description: List of teams user is a part of - items: - type: string - title: Teams - type: array - x-stream-index: "033" - updated_at: - description: Date/time of the last update - format: date-time - readOnly: true - title: Updated at - type: string - x-stream-index: "008" - required: - - id - - role - - custom - - banned - - online - title: User object - type: object UserPresenceChangedEvent: properties: created_at: @@ -9654,7 +10094,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001.001" required: - type @@ -9675,7 +10115,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -9686,6 +10126,7 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent UserRequest: + description: User request object properties: custom: additionalProperties: {} @@ -9713,15 +10154,17 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' x-stream-index: "010" required: - id + title: UserRequest type: object UserResponse: + description: User response object properties: banned: description: Whether a user is banned or not @@ -9825,6 +10268,7 @@ components: - shadow_banned - devices - invisible + title: UserResponse type: object UserUnbannedEvent: properties: @@ -9852,7 +10296,7 @@ components: type: string x-stream-index: "005.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - shadow @@ -9885,7 +10329,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -9911,7 +10355,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002" required: - type @@ -9968,7 +10412,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005.001" watcher_count: format: int32 @@ -10006,7 +10450,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" watcher_count: format: int32 @@ -10027,7 +10471,7 @@ components: VoteData: properties: Option: - $ref: '#/components/schemas/PollOption' + $ref: '#/components/schemas/PollOptionResponseData' x-stream-index: "003" answer_text: type: string @@ -10266,6 +10710,7 @@ components: - $ref: '#/components/schemas/UserUnreadReminderEvent' - $ref: '#/components/schemas/UserUpdatedEvent' WrappedUnreadCountsResponse: + description: Basic response information nullable: true properties: channel_type: @@ -10303,6 +10748,7 @@ components: - channel_type - threads - duration + title: Response type: object connectRequestQuery: nullable: true @@ -10348,7 +10794,7 @@ components: type: apiKey info: title: Stream API - version: v133.1.0 + version: v137.0.0 openapi: 3.0.3 paths: /app: @@ -10362,7 +10808,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetApplicationResponse' - description: Successful response + description: Response "400": content: application/json: @@ -10399,7 +10845,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallTokenResponse' - description: Successful response + description: Response "400": content: application/json: @@ -10444,7 +10890,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallTokenResponse' - description: Successful response + description: Response "400": content: application/json: @@ -10547,7 +10993,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -10599,6 +11045,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest required: true responses: "200": @@ -10721,7 +11168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCallResponse' - description: Successful response + description: Response "400": content: application/json: @@ -10776,7 +11223,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EventResponse' - description: Successful response + description: Response "400": content: application/json: @@ -10833,7 +11280,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -10937,7 +11384,7 @@ paths: application/json: schema: $ref: '#/components/schemas/HideChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -10994,7 +11441,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11060,6 +11507,61 @@ paths: summary: Upload image tags: - product:chat + /channels/{type}/{id}/member/{user_id}: + patch: + description: |2+ + + operationId: UpdateMemberPartial + parameters: + - in: path + name: user_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - 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: | @@ -11343,7 +11845,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShowChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11399,7 +11901,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11505,7 +12007,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11679,7 +12181,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11705,7 +12207,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListDevicesResponse' - description: Successful response + description: ListDevicesResponse "400": content: application/json: @@ -11730,6 +12232,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": @@ -11737,7 +12240,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11904,7 +12407,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11943,7 +12446,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11994,7 +12497,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12092,7 +12595,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12143,7 +12646,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendReactionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12203,7 +12706,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactionRemovalResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12304,7 +12807,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryReactionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12352,7 +12855,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12588,7 +13091,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetRepliesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12642,7 +13145,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -12681,7 +13184,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -12722,7 +13225,7 @@ paths: application/json: schema: $ref: '#/components/schemas/FlagResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12762,7 +13265,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: Successful response + description: QueryMessageFlagsResponse "400": content: application/json: @@ -12879,7 +13382,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12918,7 +13421,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13080,7 +13583,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -13326,7 +13829,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -13598,6 +14101,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SyncRequest' + description: SyncRequest required: true responses: "201": @@ -13605,7 +14109,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SyncResponse' - description: Successful response + description: SyncResponse "400": content: application/json: @@ -13805,7 +14309,7 @@ paths: application/json: schema: $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Successful response + description: Response "400": content: application/json: diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json index e8ebbeed..01889c8b 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","notification_template"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"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"},"AgoraCall":{"properties":{"channel":{"type":"string","x-stream-index":"001"}},"required":["channel"],"type":"object"},"AppResponseFields":{"properties":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"039"},"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":"042"},"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"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"041"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"040"},"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_enabled":{"type":"boolean","x-stream-index":"043"},"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"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"video_provider":{"type":"string","x-stream-index":"038"},"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"],"type":"object"},"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":{"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":{"type":"string","x-stream-index":"001"}},"required":["custom"],"type":"object"},"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":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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"},"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":"011.002"},"user_id":{"type":"string","x-stream-index":"011.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":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"003"},"type":{"description":"Block list type.","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":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"005"}},"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"},"Call":{"properties":{"agora":{"$ref":"#/components/schemas/AgoraCall","x-stream-index":"005"},"hms":{"$ref":"#/components/schemas/HMSCall","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"provider":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"003"}},"required":["provider","id","type"],"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":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"007"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"009"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"008"},"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"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"ChannelConfig":{"description":"Channel configuration overrides","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"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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"},"title":"Grants","type":"object","x-stream-index":"002","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands"],"type":"object"},"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"},"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"},"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":{"ban_expires":{"format":"date-time","type":"string","x-stream-index":"013"},"banned":{"type":"boolean","x-stream-index":"012"},"channel_role":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","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":{"format":"date-time","type":"string","x-stream-index":"006"},"invite_rejected_at":{"format":"date-time","type":"string","x-stream-index":"007"},"invited":{"type":"boolean","x-stream-index":"005"},"is_moderator":{"type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"017"},"role":{"type":"string","x-stream-index":"015"},"shadow_banned":{"type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMemberResponse":{"properties":{"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":"016"},"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":"017"},"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":"015"},"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","x-stream-index":"007"},"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"},"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/UserObject","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"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":"Config","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":"Created by","x-stream-index":"008"},"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":"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":"Members","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":{"type":"string"},"title":"Own Capabilities","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":"Truncated At","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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"commands":{"description":"List of commands that channel supports","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands"],"type":"object"},"CheckExternalStorageResponse":{"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"],"type":"object"},"CheckPushRequest":{"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"},"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":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"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":"007.001"},"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":"004"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"005"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"006"},"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"},"Config":{"properties":{"app_certificate":{"type":"string","x-stream-index":"002"},"app_id":{"type":"string","x-stream-index":"001"},"default_role":{"enum":["attendee","publisher","subscriber","admin"],"type":"string","x-stream-index":"003"},"role_map":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["app_id","app_certificate"],"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"},"type":{"description":"Block list type.","enum":["regex","domain","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"},"CreateCallRequest":{"nullable":true,"properties":{"id":{"type":"string","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"type":{"enum":["audio","video"],"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"}},"required":["type","id"],"type":"object"},"CreateCallResponse":{"nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"002.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"002.002"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"token":{"type":"string","x-stream-index":"002.001"}},"required":["token","duration"],"type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Enables automatic message moderation","enum":["disabled","simple","AI"],"title":"Auto moderation","type":"string","x-stream-index":"017"},"automod_behavior":{"description":"Sets behavior of automatic moderation","enum":["flag","block"],"title":"Auto moderation behavior","type":"string","x-stream-index":"018"},"blocklist":{"description":"Name of the blocklist to use","title":"Blocklist","type":"string","x-stream-index":"022"},"blocklist_behavior":{"description":"Sets behavior of blocklist","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"023"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"024"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"019"},"connect_events":{"description":"Connect events support","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Enables custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"021"},"mark_messages_pending":{"description":"Marks messages as pending by default","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Number of maximum message characters","format":"int32","title":"Maximum message length","type":"integer","x-stream-index":"016"},"message_retention":{"type":"string","x-stream-index":"015"},"mutes":{"description":"Enables mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"format":"int32","minimum":10,"type":"integer","x-stream-index":"025"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"026"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"020"},"polls":{"description":"Enables polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Enables push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Enables message reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events support","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Enables message search","title":"Search","type":"boolean","x-stream-index":"007"},"typing_events":{"description":"Typing events support","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Enables file uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"Enables URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"}},"required":["name","max_message_length","automod","automod_behavior"],"type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.025"},"blocklist":{"type":"string","x-stream-index":"001.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Represents custom chat 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":"Command","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","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"},"CreateDeviceRequest":{"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"],"type":"object"},"CreateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"type":"object"},"CreateExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"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"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"position":{"format":"int32","type":"integer","x-stream-index":"003"},"text":{"description":"Option text","title":"string","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"}},"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":{"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"],"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":{"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"],"type":"object"},"DeactivateUsersResponse":{"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"],"type":"object"},"DeleteChannelResponse":{"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"],"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":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","duration"],"type":"object"},"DeleteExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteMessageResponse":{"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"],"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"},"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.006"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.005"},"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":{"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":"Device","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"},"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"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled","apns"],"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":{"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"],"type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":25,"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"},"ExportChannelsResult":{"properties":{"path":{"description":"S3 path of result","title":"PathPrefix","type":"string","x-stream-index":"002"},"s3_bucket_name":{"description":"S3 bucket name result","title":"S3 bucket name","type":"string","x-stream-index":"003"},"url":{"description":"URL of result","title":"URL","type":"string","x-stream-index":"001"}},"required":["url"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"},"reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","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":{"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"],"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"},"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","notification_template","data_template","apn_template"],"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/UserObject","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/UserObject","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":{"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"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"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"},"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.009"}},"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":{"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"],"type":"object"},"GetBlockListResponse":{"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":"Get Block list response","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"},"GetCallTokenRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"GetCallTokenResponse":{"nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"001.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"001.002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"token":{"type":"string","x-stream-index":"001.001"}},"required":["token","duration"],"type":"object"},"GetChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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":{"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands","duration"],"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"],"type":"object"},"GetCustomPermissionResponse":{"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"],"type":"object"},"GetExportChannelsStatusResponse":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.007.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Contains task error in case of failure","title":"Error","x-stream-index":"003"},"result":{"$ref":"#/components/schemas/ExportChannelsResult","description":"Contains task result in case of success","title":"ExportChannelsResult","x-stream-index":"002"},"status":{"description":"Task status","enum":["waiting","pending","running","completed","failed","canceled"],"title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"type":"object"},"GetImportResponse":{"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"],"type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/Message"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"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"],"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"},"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":{"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"],"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"},"HMSCall":{"properties":{"room_id":{"type":"string","x-stream-index":"001"},"room_name":{"type":"string","x-stream-index":"002"}},"required":["room_id","room_name"],"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"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":{"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"ListBlockListResponse":{"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"],"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"],"type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"type":"object"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"type":"object"},"ListExternalStorageResponse":{"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"],"type":"object"},"ListImportsResponse":{"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"],"type":"object"},"ListPermissionsResponse":{"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"],"type":"object"},"ListPushProvidersResponse":{"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"],"type":"object"},"ListRolesResponse":{"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"],"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"},"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":{"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":"011"},"before_message_send_failed":{"description":"Whether `before_message_send webhook` failed or not. Field is only accessible in push webhook","title":"Before Message Send Failed","type":"boolean","x-stream-docs-page-id":"before_message_send_webhook","x-stream-index":"045"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"027"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"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":"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":"043"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","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":"039"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Latest reactions","type":"array","x-stream-index":"012"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserObject"},"title":"Mentioned Users","type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"051"},"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":"005"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Own reactions","type":"array","x-stream-index":"013"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"018"},"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":"050"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"046"},"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":"047"},"pinned_by":{"$ref":"#/components/schemas/UserObject","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"024"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"023"},"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":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"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":"015"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"021"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"035"},"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":"020"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"044"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"004"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserObject"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"026"},"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":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/UserObject","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"010"}},"required":["id","text","html","type","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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"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"},"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"},"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":"AI moderation response","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":"Moderation 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"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"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"},"last_read_message_id":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"004.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"001.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"MessageReadEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"020.002"},"user_id":{"type":"string","x-stream-index":"020.001"}},"type":"object"},"MessageResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"008"},"cid":{"type":"string","x-stream-index":"021"},"command":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"html":{"type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"029"},"id":{"type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"027"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"035"},"mml":{"type":"string","x-stream-index":"003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"010"},"parent_id":{"type":"string","x-stream-index":"014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"034"},"pinned":{"type":"boolean","x-stream-index":"031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"037"},"poll_id":{"type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"019"},"quoted_message_id":{"type":"string","x-stream-index":"018"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"016"},"shadowed":{"type":"boolean","x-stream-index":"026"},"show_in_channel":{"type":"boolean","x-stream-index":"015"},"silent":{"type":"boolean","x-stream-index":"030"},"text":{"type":"string","x-stream-index":"002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"020"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"023"},"user":{"$ref":"#/components/schemas/UserResponse","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"],"type":"object"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageWithChannelResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"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","channel"],"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"},"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"},"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"014"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"042"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"027"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"012"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"025"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"type":"string","x-stream-index":"032"},"last_active":{"format":"date-time","type":"string","x-stream-index":"010"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"026"},"online":{"type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"033"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"028"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"031"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"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"},"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":{"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"],"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/UserObject","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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"020"},"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":"018"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"created_by_id":{"type":"string","x-stream-index":"016"},"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_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":"015"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"019"},"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","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/UserObject","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"],"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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","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":"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"},"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"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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"},"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"},"QueryMembersPayload":{"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"],"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/SortParam"},"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":{"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"],"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":{"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"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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":{"description":"Represents user reaction to a message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"description":"ID of a message user reacted to","title":"Message ID","type":"string","x-stream-index":"003"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"007"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"description":"ID of a user who reacted to a message","title":"User ID","type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"string","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"string","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"type":"object"},"ReactionRemovalResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"type":"object"},"ReactionRequest":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"format":"int32","type":"integer","x-stream-index":"002"},"type":{"maxLength":30,"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","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"],"type":"object"},"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"},"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":{"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"],"type":"object"},"ReactivateUsersResponse":{"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"],"type":"object"},"Read":{"nullable":true,"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/UserObject","x-stream-index":"001"}},"required":["last_read","unread_messages"],"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":["audio_only","mode","quality"],"type":"object"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"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":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"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"],"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":{"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":{"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"],"type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, -1 for descending, 1 for ascending","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"},"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"},"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":"002"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"011"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"010"},"last_thread_message_at":{"format":"date-time","type":"string","x-stream-index":"004"},"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":"009"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","description":"User is the user object","title":"User","x-stream-index":"007"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"006"}},"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/UserObject","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/Message","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":{"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"},"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/Read"},"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"},"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"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"title":"string","type":"string","x-stream-index":"002"},"languages":{"description":"the languages to transcribe to","items":{"type":"string"},"maximum":2,"title":"array","type":"array","x-stream-index":"003"},"mode":{"description":"oneof=available disabled auto-on","enum":["available","disabled","auto-on"],"title":"string","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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":{"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"],"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":{"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"],"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":"004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"003"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"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":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.040"},"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.042"},"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.043"},"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"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.045"},"feeds_v2_region":{"type":"string","x-stream-index":"001.044"},"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"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.041"},"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_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_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"video_provider":{"enum":["agora","hms"],"type":"string","x-stream-index":"001.039"},"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":{"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.025"},"blocklist":{"type":"string","x-stream-index":"009.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.023"},"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.018"},"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"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.025"},"blocklist":{"type":"string","x-stream-index":"003.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"description":"Represents custom chat 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"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"Command","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"type":"object"},"UpdateExternalStorageResponse":{"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"],"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":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"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"],"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"},"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"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"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"],"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"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/UserObject","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/UserObject","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"},"UserObject":{"description":"Represents chat user","properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"015"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"014"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","readOnly":true,"title":"Deactivated at","type":"string","x-stream-index":"012"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","readOnly":true,"title":"Deleted at","type":"string","x-stream-index":"011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"032"},"last_active":{"description":"Date of last activity","format":"date-time","readOnly":true,"title":"Last active","type":"string","x-stream-index":"010"},"online":{"description":"Whether a user online or not","readOnly":true,"title":"Online","type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"039"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"004"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"033"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"title":"User object","type":"object"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"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"},"VoteData":{"properties":{"Option":{"$ref":"#/components/schemas/PollOption","x-stream-index":"003"},"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":"022"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"023"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"010"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_type":{"type":"string","x-stream-index":"006"},"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":"027"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"021"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"018"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"013"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"007"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"008"},"parent_id":{"type":"string","x-stream-index":"024"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"014"},"poll_vote":{"$ref":"#/components/schemas/PollVote","x-stream-index":"015"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"009"},"reason":{"type":"string","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"025"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"012"},"thread_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"016"},"user_id":{"type":"string","x-stream-index":"017"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"019"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WrappedUnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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"],"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":"v133.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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"description":"Successful response"},"400":{"content":{"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/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"Get Block list response"},"400":{"content":{"application/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/Response"}}},"description":"Successful response"},"400":{"content":{"application/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"]}},"/calls":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/calls/{call_id}":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/channels":{"post":{"description":"Query channels with filter query\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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"}}},"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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/call":{"post":{"description":"Creates a call\n\nRequired permissions:\n- CreateCall\n- ReadChannel\n","operationId":"CreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 call","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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":"Successful response"},"400":{"content":{"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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"}}},"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"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":"Successful response"},"400":{"content":{"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":"Command","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Command","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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"]}},"/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":"Successful response"},"400":{"content":{"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"]}},"/export_channels/{id}":{"get":{"description":"\n","operationId":"GetExportChannelsStatus","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/GetExportChannelsStatusResponse"}}},"description":"Successful response"},"400":{"content":{"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 status","tags":["product:chat"]}},"/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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":"Successful response"},"400":{"content":{"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","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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"description":"Successful response"},"400":{"content":{"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","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","type":"string","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- BanChannelMember\n- BanUser\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BanChannelMember\n- BanUser\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- FlagMessage\n- FlagUser\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","tags":["product:chat"]}},"/moderation/flags/message":{"get":{"description":"Find and filter message flags\n\nRequired permissions:\n- ReadMessageFlags\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":"Successful response"},"400":{"content":{"application/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.muted\n\nRequired permissions:\n- MuteUser\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteUser\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- MuteChannel\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.deleted\n\nRequired permissions:\n- DeletePoll\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":"Successful response"},"400":{"content":{"application/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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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":"Successful response"},"400":{"content":{"application/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_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"description":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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"]}},"/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"description":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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"]}},"/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"]}},"/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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://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","notification_template"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"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"},"AgoraCall":{"properties":{"channel":{"type":"string","x-stream-index":"001"}},"required":["channel"],"type":"object"},"AppResponseFields":{"properties":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"039"},"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":"042"},"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"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"041"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"040"},"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_enabled":{"type":"boolean","x-stream-index":"043"},"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"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"video_provider":{"type":"string","x-stream-index":"038"},"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"],"type":"object"},"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":"021"},"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":"022"},"image_url":{"type":"string","x-stream-index":"011"},"latitude":{"format":"float","type":"number","x-stream-index":"018"},"longitude":{"format":"float","type":"number","x-stream-index":"019"},"og_scrape_url":{"type":"string","x-stream-index":"023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"024"},"pretext":{"type":"string","x-stream-index":"004"},"stopped_sharing":{"type":"boolean","x-stream-index":"020"},"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":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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"},"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":"011.002"},"user_id":{"type":"string","x-stream-index":"011.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","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"003"},"type":{"description":"Block list type.","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":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"005"}},"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"},"Call":{"properties":{"agora":{"$ref":"#/components/schemas/AgoraCall","x-stream-index":"005"},"hms":{"$ref":"#/components/schemas/HMSCall","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"provider":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"003"}},"required":["provider","id","type"],"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":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"007"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"009"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"008"},"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":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"string","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"string","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"ChannelConfig":{"description":"Channel configuration overrides","properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.028"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"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"},"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"},"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":{"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","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","create-call","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-call","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-typing-events","set-channel-cooldown","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":"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.028"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"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"},"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":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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":"007.001"},"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":"004"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"005"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"006"},"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"},"Config":{"properties":{"app_certificate":{"type":"string","x-stream-index":"002"},"app_id":{"type":"string","x-stream-index":"001"},"default_role":{"enum":["attendee","publisher","subscriber","admin"],"type":"string","x-stream-index":"003"},"role_map":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["app_id","app_certificate"],"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"},"type":{"description":"Block list type.","enum":["regex","domain","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"},"CreateCallRequest":{"nullable":true,"properties":{"id":{"type":"string","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"type":{"enum":["audio","video"],"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"}},"required":["type","id"],"type":"object"},"CreateCallResponse":{"description":"Basic response information","nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"002.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"002.002"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"token":{"type":"string","x-stream-index":"002.001"}},"required":["token","duration"],"title":"Response","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"017"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"018"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"022"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"023"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"024"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"019"},"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":"021"},"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":"016"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"015"},"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":"025"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"026"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"020"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"027"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.025"},"blocklist":{"type":"string","x-stream-index":"001.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.028"},"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"}},"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","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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"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":"004"},"position":{"format":"int32","type":"integer","x-stream-index":"003"},"text":{"description":"Option text","title":"string","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"}},"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"},"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"},"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"},"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.006"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.005"},"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"},"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"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled","apns"],"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":25,"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"},"ExportChannelsResult":{"properties":{"path":{"description":"S3 path of result","title":"PathPrefix","type":"string","x-stream-index":"002"},"s3_bucket_name":{"description":"S3 bucket name result","title":"S3 bucket name","type":"string","x-stream-index":"003"},"url":{"description":"URL of result","title":"URL","type":"string","x-stream-index":"001"}},"required":["url"],"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"},"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","notification_template","data_template","apn_template"],"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"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GetCallTokenRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"GetCallTokenResponse":{"description":"Basic response information","nullable":true,"properties":{"agora_app_id":{"type":"string","x-stream-index":"001.003"},"agora_uid":{"format":"int32","type":"integer","x-stream-index":"001.002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"token":{"type":"string","x-stream-index":"001.001"}},"required":["token","duration"],"title":"Response","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":"002.001"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.028"},"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"}},"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","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"},"GetExportChannelsStatusResponse":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.007.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Contains task error in case of failure","title":"Error","x-stream-index":"003"},"result":{"$ref":"#/components/schemas/ExportChannelsResult","description":"Contains task result in case of success","title":"ExportChannelsResult","x-stream-index":"002"},"status":{"description":"Task status","enum":["waiting","pending","running","completed","failed","canceled"],"title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"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.021"},"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.022"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"latitude":{"format":"float","type":"number","x-stream-index":"001.018"},"longitude":{"format":"float","type":"number","x-stream-index":"001.019"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.024"},"pretext":{"type":"string","x-stream-index":"001.004"},"stopped_sharing":{"type":"boolean","x-stream-index":"001.020"},"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"},"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"},"HMSCall":{"properties":{"room_id":{"type":"string","x-stream-index":"001"},"room_name":{"type":"string","x-stream-index":"002"}},"required":["room_id","room_name"],"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"},"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","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"},"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"},"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":"011"},"before_message_send_failed":{"type":"boolean","x-stream-index":"045"},"cid":{"type":"string","x-stream-index":"027"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"043"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"039"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"012"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"051"},"mml":{"type":"string","x-stream-index":"005"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"parent_id":{"type":"string","x-stream-index":"018"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"050"},"pinned":{"type":"boolean","x-stream-index":"046"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"047"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"024"},"quoted_message_id":{"type":"string","x-stream-index":"023"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"021"},"shadowed":{"type":"boolean","x-stream-index":"035"},"show_in_channel":{"type":"boolean","x-stream-index":"020"},"silent":{"type":"boolean","x-stream-index":"044"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"026"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","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"},"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"},"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"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"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":"008"},"last_read_message_id":{"type":"string","x-stream-index":"009"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["cid","channel_id","channel_type","type","created_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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"020.002"},"user_id":{"type":"string","x-stream-index":"020.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":"021"},"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":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"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":"029"},"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":"027"},"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":"028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"035"},"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"},"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":"014"},"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":"034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"031"},"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":"032"},"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":"033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"018"},"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":"013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"016"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"026"},"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":"015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"030"},"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":"020"},"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":"023"},"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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"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.021"},"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.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"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.029"},"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.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"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"},"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.014"},"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.034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.031"},"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.032"},"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.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.036"},"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.019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.018"},"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.013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.016"},"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.026"},"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.015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.030"},"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.020"},"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.023"},"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","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"},"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"},"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"043"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"028"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"013"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"012"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"026"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","type":"string","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","type":"string","x-stream-index":"011"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"027"},"online":{"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"031"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"032"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"021"},"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"},"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"],"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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","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":"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"},"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"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"}},"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"},"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"},"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":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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"},"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"},"ReactionRemovalResponse":{"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/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"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"},"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"},"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":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"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"],"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"},"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":"002.001"}},"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"},"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"},"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"},"languages":{"description":"the languages to transcribe to","items":{"type":"string"},"maximum":2,"title":"array","type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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":"004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"003"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"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":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.040"},"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.042"},"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.043"},"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"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.045"},"feeds_v2_region":{"type":"string","x-stream-index":"001.044"},"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"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.041"},"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_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_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"video_provider":{"enum":["agora","hms"],"type":"string","x-stream-index":"001.039"},"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":{"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.025"},"blocklist":{"type":"string","x-stream-index":"009.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.023"},"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.018"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.028"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.025"},"blocklist":{"type":"string","x-stream-index":"003.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.028"},"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"}},"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","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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"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"},"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":"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"},"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"},"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":{"ban_expires":{"format":"date-time","type":"string","x-stream-index":"016"},"banned":{"type":"boolean","x-stream-index":"015"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"040"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","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"},"VoteData":{"properties":{"Option":{"$ref":"#/components/schemas/PollOptionResponseData","x-stream-index":"003"},"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":"021"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"022"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"009"},"channel_id":{"type":"string","x-stream-index":"004"},"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":"026"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"020"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"017"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"007"},"parent_id":{"type":"string","x-stream-index":"023"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"013"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"014"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"024"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"011"},"thread_id":{"type":"string","x-stream-index":"010"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"015"},"user_id":{"type":"string","x-stream-index":"016"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"018"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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":"v137.0.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","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/Response"}}},"description":"Response"},"400":{"content":{"application/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":{"description":"Block list 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 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"}}],"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/Response"}}},"description":"Response"},"400":{"content":{"application/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"]}},"/calls":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/calls/{call_id}":{"post":{"description":"Retrieves the token to join a call\n\nRequired permissions:\n- JoinCall\n- ReadChannel\n","operationId":"GetCallToken","parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTokenResponse"}}},"description":"Response"},"400":{"content":{"application/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 Token","tags":["product:chat"]}},"/campaigns/query":{"post":{"description":"Query campaigns\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 campaign","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"}}],"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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/call":{"post":{"description":"Creates a call\n\nRequired permissions:\n- CreateCall\n- ReadChannel\n","operationId":"CreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallResponse"}}},"description":"Response"},"400":{"content":{"application/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 call","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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"]}},"/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"]}},"/export_channels/{id}":{"get":{"description":"\n","operationId":"GetExportChannelsStatus","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/GetExportChannelsStatusResponse"}}},"description":"Successful response"},"400":{"content":{"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 status","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"}}},"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"}}},"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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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","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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.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","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","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\nRequired permissions:\n- BanChannelMember\n- BanUser\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\nRequired permissions:\n- BanChannelMember\n- BanUser\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\nRequired permissions:\n- FlagMessage\n- FlagUser\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\nRequired permissions:\n- ReadMessageFlags\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.muted\n\nRequired permissions:\n- MuteUser\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteUser\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.deleted\n\nRequired permissions:\n- DeletePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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_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"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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"]}},"/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\nRequired permissions:\n- ReadChannel\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":"ControllerNameQuerySegmentTargets","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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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"]}},"/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\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://stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/chat-openapi.yaml b/openapi/chat-openapi.yaml index 5a1efed2..17609179 100644 --- a/openapi/chat-openapi.yaml +++ b/openapi/chat-openapi.yaml @@ -394,6 +394,8 @@ components: 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: @@ -419,7 +421,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "018" + x-stream-index: "021" fallback: type: string x-stream-index: "002" @@ -436,24 +438,35 @@ components: x-stream-index: "014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "019" + x-stream-index: "022" image_url: type: string x-stream-index: "011" + latitude: + format: float + type: number + x-stream-index: "018" + longitude: + format: float + type: number + x-stream-index: "019" og_scrape_url: type: string - x-stream-index: "020" + x-stream-index: "023" original_height: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "025" original_width: format: int32 type: integer - x-stream-index: "021" + x-stream-index: "024" pretext: type: string x-stream-index: "004" + stopped_sharing: + type: boolean + x-stream-index: "020" text: type: string x-stream-index: "010" @@ -467,11 +480,15 @@ components: 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: @@ -643,13 +660,17 @@ components: 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: @@ -894,6 +915,173 @@ components: - UpdatedAt - ExternalStorage type: object + CampaignChannelTemplate: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + id: + type: string + x-stream-index: "002" + members: + items: + type: string + maximum: 1000 + type: array + x-stream-index: "003" + type: + maxLength: 64 + type: string + x-stream-index: "001" + required: + - type + - custom + type: object + 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: "014" + create_channels: + type: boolean + x-stream-index: "007" + created_at: + format: date-time + type: string + x-stream-index: "018" + description: + type: string + x-stream-index: "008" + id: + type: string + x-stream-index: "001" + message_template: + $ref: '#/components/schemas/CampaignMessageTemplate' + x-stream-index: "013" + name: + type: string + x-stream-index: "006" + scheduled_for: + format: date-time + type: string + x-stream-index: "011" + 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" + skip_push: + type: boolean + x-stream-index: "009" + skip_webhook: + type: boolean + x-stream-index: "010" + stats: + $ref: '#/components/schemas/CampaignStatsResponse' + x-stream-index: "020" + status: + type: string + x-stream-index: "017" + stop_at: + format: date-time + type: string + x-stream-index: "012" + updated_at: + format: date-time + type: string + x-stream-index: "019" + user_ids: + items: + type: string + type: array + x-stream-index: "015" + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "016" + required: + - id + - segment_ids + - segments + - sender_id + - name + - create_channels + - description + - skip_push + - skip_webhook + - user_ids + - users + - status + - created_at + - updated_at + - stats + type: object + 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" + required: + - stats_started_at + - stats_completed_at + - stats_messages_sent + - stats_channels_created + - progress + type: object CastPollVoteRequest: nullable: true properties: @@ -922,8 +1110,10 @@ components: type: string x-stream-index: "009" commands: + description: List of commands that channel supports items: type: string + title: Commands type: array x-stream-index: "011" grants: @@ -1035,13 +1225,8 @@ components: items: type: string type: array - title: Grants type: object x-stream-index: "002" - x-stream-map: - description: List of grants modifiers that apply to a role - key: role - title: Grants mark_messages_pending: type: boolean x-stream-index: 001.002.015 @@ -1090,6 +1275,9 @@ components: search: type: boolean x-stream-index: 001.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.028 typing_events: type: boolean x-stream-index: 001.002.002 @@ -1126,6 +1314,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands type: object ChannelExport: @@ -1244,18 +1433,30 @@ components: 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: "016" + x-stream-index: "018" created_at: + description: Date/time of creation format: date-time + title: Created at type: string x-stream-index: "009" custom: @@ -1267,39 +1468,64 @@ components: 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: "017" + 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: "015" + 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: @@ -1310,9 +1536,14 @@ components: - shadow_banned - channel_role - notifications_muted + title: Channel member type: object ChannelMemberResponse: properties: + archived_at: + format: date-time + type: string + x-stream-index: "016" ban_expires: description: Expiration date of the ban format: date-time @@ -1328,7 +1559,7 @@ components: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "016" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time @@ -1367,7 +1598,11 @@ components: x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "017" + 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)' @@ -1378,7 +1613,7 @@ components: - owner title: Role type: string - x-stream-index: "015" + x-stream-index: "017" shadow_banned: description: Whether member is shadow banned in this channel or not title: Shadow banned @@ -1415,34 +1650,75 @@ components: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "007" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "009" + x-stream-index: "004" expires: description: Date/time of mute expiration format: date-time title: Expires type: string - x-stream-index: "008" + x-stream-index: "003" updated_at: description: Date/time of the last update format: date-time title: Updated at type: string - x-stream-index: "010" + x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Owner of channel mute title: User - x-stream-index: "005" + 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 + - create-call + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-call + - 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-typing-events + - set-channel-cooldown + - 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: @@ -1469,7 +1745,7 @@ components: config: $ref: '#/components/schemas/ChannelConfigWithInfo' description: Channel configuration - title: Config + title: ChannelConfigWithInfo x-stream-index: "013" cooldown: description: Cooldown period after sending each message @@ -1486,10 +1762,12 @@ components: created_by: $ref: '#/components/schemas/UserResponse' description: Creator of the channel - title: Created by + 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: @@ -1538,7 +1816,7 @@ components: description: List of channel members (max 100) items: $ref: '#/components/schemas/ChannelMember' - title: Members + title: ChannelMembers type: array x-stream-index: "011" mute_expires_at: @@ -1555,8 +1833,8 @@ components: own_capabilities: description: List of channel capabilities of authenticated user items: - type: string - title: Own Capabilities + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability type: array x-stream-index: "021" team: @@ -1567,7 +1845,7 @@ components: truncated_at: description: Date of the latest truncation of the channel format: date-time - title: Truncated At + title: UserResponse type: string x-stream-index: "024" truncated_by: @@ -1783,10 +2061,8 @@ components: type: array x-stream-index: 003.002.023 commands: - description: List of commands that channel supports items: $ref: '#/components/schemas/Command' - title: Commands type: array x-stream-index: "003.003" connect_events: @@ -1859,6 +2135,9 @@ components: search: type: boolean x-stream-index: 003.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.028 typing_events: type: boolean x-stream-index: 003.002.002 @@ -1897,9 +2176,11 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands type: object CheckExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -1913,8 +2194,10 @@ components: required: - duration - file_url + title: Response type: object CheckPushRequest: + description: Check push request nullable: true properties: apn_template: @@ -1966,6 +2249,7 @@ components: user_id: type: string x-stream-index: "008.001" + title: CheckPushRequest type: object CheckPushResponse: nullable: true @@ -2241,6 +2525,7 @@ components: - id type: object CreateCallResponse: + description: Basic response information nullable: true properties: agora_app_id: @@ -2264,34 +2549,35 @@ components: required: - token - duration + title: Response type: object CreateChannelTypeRequest: nullable: true properties: automod: - description: Enables automatic message moderation + description: Automod enum: - disabled - simple - AI - title: Auto moderation + title: Automod type: string x-stream-index: "017" automod_behavior: - description: Sets behavior of automatic moderation + description: Automod behavior enum: - flag - block - title: Auto moderation behavior + title: Automod behavior type: string x-stream-index: "018" blocklist: - description: Name of the blocklist to use + description: Blocklist title: Blocklist type: string x-stream-index: "022" blocklist_behavior: - description: Sets behavior of blocklist + description: Blocklist behavior enum: - flag - block @@ -2300,8 +2586,10 @@ components: type: string x-stream-index: "023" blocklists: + description: Blocklists items: $ref: '#/components/schemas/BlockListOptions' + title: Blocklists type: array x-stream-index: "024" commands: @@ -2312,12 +2600,12 @@ components: type: array x-stream-index: "019" connect_events: - description: Connect events support + description: Connect events title: Connect events type: boolean x-stream-index: "004" custom_events: - description: Enables custom events + description: Custom events title: Custom events type: boolean x-stream-index: "011" @@ -2326,24 +2614,31 @@ components: items: type: string type: array + description: List of grants for the channel type + title: Grants type: object x-stream-index: "021" mark_messages_pending: - description: Marks messages as pending by default + description: Mark messages pending title: Mark messages pending type: boolean x-stream-index: "013" max_message_length: - description: Number of maximum message characters + description: Max message length format: int32 - title: Maximum message length + title: Max message length type: integer x-stream-index: "016" message_retention: + description: Message retention + enum: + - infinite + - numeric + title: Message retention type: string x-stream-index: "015" mutes: - description: Enables mutes + description: Mutes title: Mutes type: boolean x-stream-index: "008" @@ -2353,14 +2648,18 @@ components: type: string x-stream-index: "001" partition_size: + description: Partition size format: int32 minimum: 10 + title: Partition size type: integer x-stream-index: "025" partition_ttl: + description: Partition TTL example: 24h format: duration nullable: true + title: Partition TTL type: string x-stream-index: "026" permissions: @@ -2371,47 +2670,50 @@ components: type: array x-stream-index: "020" polls: - description: Enables polls + description: Polls title: Polls type: boolean x-stream-index: "014" push_notifications: - description: Enables push notifications + description: Push notifications title: Push notifications type: boolean x-stream-index: "012" reactions: - description: Enables message reactions + description: Reactions title: Reactions type: boolean x-stream-index: "005" read_events: - description: Read events support + description: Read events title: Read events type: boolean x-stream-index: "003" replies: - description: Enables message replies (threads) + description: Replies title: Replies type: boolean x-stream-index: "006" search: - description: Enables message search + description: Search title: Search type: boolean x-stream-index: "007" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "027" typing_events: - description: Typing events support + description: Typing events title: Typing events type: boolean x-stream-index: "002" uploads: - description: Enables file uploads + description: Uploads title: Uploads type: boolean x-stream-index: "009" url_enrichment: - description: Enables URL enrichment + description: URL enrichment title: URL enrichment type: boolean x-stream-index: "010" @@ -2420,6 +2722,7 @@ components: - max_message_length - automod - automod_behavior + title: CreateChannelTypeRequest type: object CreateChannelTypeResponse: nullable: true @@ -2539,6 +2842,9 @@ components: search: type: boolean x-stream-index: 001.001.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.001.028 typing_events: type: boolean x-stream-index: 001.001.002 @@ -2573,6 +2879,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - created_at - updated_at - commands @@ -2581,7 +2888,7 @@ components: - duration type: object CreateCommandRequest: - description: Represents custom chat command + description: Create a new command nullable: true properties: args: @@ -2612,23 +2919,25 @@ components: required: - name - description - title: Command + title: CreateCommandRequest type: object CreateCommandResponse: nullable: true properties: command: $ref: '#/components/schemas/Command' + description: Command object + title: Command x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" required: - duration + title: CreateCommandResponse type: object CreateDeviceRequest: + description: Create device request nullable: true properties: id: @@ -2669,6 +2978,7 @@ components: required: - id - push_provider + title: CreateDeviceRequest type: object CreateExternalStorageRequest: nullable: true @@ -2704,6 +3014,7 @@ components: - bucket type: object CreateExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -2713,6 +3024,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object CreateGuestRequest: nullable: true @@ -2765,6 +3077,7 @@ components: - mode type: object CreateImportResponse: + description: Basic response information nullable: true properties: duration: @@ -2777,6 +3090,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object CreateImportURLRequest: nullable: true @@ -2786,6 +3100,7 @@ components: x-stream-index: "001" type: object CreateImportURLResponse: + description: Basic response information nullable: true properties: duration: @@ -2803,6 +3118,7 @@ components: - path - upload_url - duration + title: Response type: object CreatePollOptionRequest: nullable: true @@ -2913,6 +3229,7 @@ components: - name type: object CreateRoleResponse: + description: Basic response information nullable: true properties: duration: @@ -2926,6 +3243,7 @@ components: required: - duration - role + title: Response type: object DataDogInfo: properties: @@ -2970,6 +3288,7 @@ components: - duration type: object DeactivateUsersRequest: + description: Deactivate users request nullable: true properties: created_by_id: @@ -2996,8 +3315,10 @@ components: x-stream-index: "001" required: - user_ids + title: DeactivateUsersRequest type: object DeactivateUsersResponse: + description: Basic response information nullable: true properties: duration: @@ -3011,8 +3332,10 @@ components: required: - task_id - duration + title: Response type: object DeleteChannelResponse: + description: Basic response information nullable: true properties: channel: @@ -3025,6 +3348,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteChannelsRequest: nullable: true @@ -3083,18 +3407,20 @@ components: nullable: true properties: duration: - description: Duration of the request in milliseconds - title: 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: @@ -3104,8 +3430,10 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -3119,16 +3447,32 @@ components: required: - message - duration + title: Response type: object - DeleteUsersRequest: + DeleteSegmentTargetsRequest: 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 + 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. + 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: @@ -3216,6 +3560,62 @@ components: - 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: @@ -3264,23 +3664,7 @@ components: - id - created_at - user_id - title: Device - 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 + title: DeviceResponse type: object ErrorResult: properties: @@ -3331,6 +3715,7 @@ components: - type type: object EventResponse: + description: Basic response information nullable: true properties: duration: @@ -3344,6 +3729,7 @@ components: required: - event - duration + title: Response type: object ExportChannelsRequest: nullable: true @@ -3429,17 +3815,23 @@ components: type: string x-stream-index: "004.001" messages: + description: List of exported messages items: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' + title: Messages type: array x-stream-index: "002" reactions: + description: List of exported reactions items: - $ref: '#/components/schemas/Reaction' + $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 @@ -3458,6 +3850,7 @@ components: - user_ids type: object ExportUsersResponse: + description: Basic response information nullable: true properties: duration: @@ -3471,6 +3864,7 @@ components: required: - task_id - duration + title: Response type: object ExternalStorageResponse: properties: @@ -3681,7 +4075,7 @@ components: type: string x-stream-index: "007" target_user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: Flagged user title: User x-stream-index: "010" @@ -3692,7 +4086,7 @@ components: type: string x-stream-index: "012" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: User who flagged a message or a user title: User x-stream-index: "006" @@ -3782,6 +4176,7 @@ components: x-stream-index: "005.001" type: object FlagResponse: + description: Basic response information nullable: true properties: duration: @@ -3798,6 +4193,7 @@ components: required: - review_queue_item_id - duration + title: Response type: object FullUserResponse: properties: @@ -3832,7 +4228,7 @@ components: x-stream-index: "001.010" devices: items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' type: array x-stream-index: "004" id: @@ -3960,6 +4356,7 @@ components: - names type: object GetApplicationResponse: + description: Basic response information nullable: true properties: app: @@ -3973,8 +4370,10 @@ components: required: - app - duration + title: Response type: object GetBlockListResponse: + description: Response for get block list nullable: true properties: blocklist: @@ -3987,7 +4386,7 @@ components: x-stream-index: "002.001" required: - duration - title: Get Block list response + title: GetBlockListResponse type: object x-stream-docs-page-id: get_block_list GetBlockedUsersResponse: @@ -4020,6 +4419,7 @@ components: x-stream-index: "002.001" type: object GetCallTokenResponse: + description: Basic response information nullable: true properties: agora_app_id: @@ -4040,8 +4440,26 @@ components: required: - token - duration + title: Response + 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: "002.001" + required: + - duration + title: Response type: object GetChannelTypeResponse: + description: Basic response information nullable: true properties: allowed_flag_reasons: @@ -4097,6 +4515,8 @@ components: 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: @@ -4159,6 +4579,9 @@ components: search: type: boolean x-stream-index: 003.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.028 typing_events: type: boolean x-stream-index: 003.002.002 @@ -4197,8 +4620,10 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands - duration + title: Response type: object GetCommandResponse: nullable: true @@ -4234,8 +4659,10 @@ components: - args - set - duration + title: GetCommandResponse type: object GetCustomPermissionResponse: + description: Basic response information nullable: true properties: duration: @@ -4249,6 +4676,7 @@ components: required: - permission - duration + title: Response type: object GetExportChannelsStatusResponse: nullable: true @@ -4304,6 +4732,7 @@ components: - duration type: object GetImportResponse: + description: Basic response information nullable: true properties: duration: @@ -4316,6 +4745,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object GetManyMessagesResponse: nullable: true @@ -4326,7 +4756,7 @@ components: messages: description: List of messages items: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' title: Messages type: array x-stream-index: "001.001" @@ -4335,6 +4765,7 @@ components: - duration type: object GetMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -4353,6 +4784,7 @@ components: required: - message - duration + title: Response type: object GetOGResponse: nullable: true @@ -4386,7 +4818,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "001.018" + x-stream-index: "001.021" duration: type: string x-stream-index: "002.001" @@ -4406,28 +4838,39 @@ components: x-stream-index: "001.014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "001.019" + x-stream-index: "001.022" image_url: description: URL of detected image title: Image URL type: string x-stream-index: "001.011" + latitude: + format: float + type: number + x-stream-index: "001.018" + longitude: + format: float + type: number + x-stream-index: "001.019" og_scrape_url: description: extracted url from the text title: OG Scrape URL type: string - x-stream-index: "001.020" + x-stream-index: "001.023" original_height: format: int32 type: integer - x-stream-index: "001.022" + x-stream-index: "001.025" original_width: format: int32 type: integer - x-stream-index: "001.021" + x-stream-index: "001.024" pretext: type: string x-stream-index: "001.004" + stopped_sharing: + type: boolean + x-stream-index: "001.020" text: description: og:description title: Text @@ -4532,6 +4975,7 @@ components: - duration type: object GetRepliesResponse: + description: Basic response information nullable: true properties: duration: @@ -4547,6 +4991,23 @@ components: 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 @@ -4656,6 +5117,7 @@ components: x-stream-index: "003.001" type: object HideChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -4665,6 +5127,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object HuaweiConfig: properties: @@ -4907,15 +5370,19 @@ components: 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 @@ -4984,6 +5451,7 @@ components: x-stream-index: "001" type: object ListBlockListResponse: + description: Basic response information nullable: true properties: blocklists: @@ -4999,6 +5467,7 @@ components: required: - blocklists - duration + title: Response type: object ListChannelTypesResponse: nullable: true @@ -5020,31 +5489,34 @@ components: 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: - description: Duration of the request in milliseconds - title: 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/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "001" @@ -5054,8 +5526,10 @@ components: required: - devices - duration + title: ListDevicesResponse type: object ListExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -5071,8 +5545,10 @@ components: required: - duration - external_storages + title: Response type: object ListImportsResponse: + description: Basic response information nullable: true properties: duration: @@ -5088,8 +5564,10 @@ components: required: - import_tasks - duration + title: Response type: object ListPermissionsResponse: + description: Basic response information nullable: true properties: duration: @@ -5105,8 +5583,10 @@ components: required: - permissions - duration + title: Response type: object ListPushProvidersResponse: + description: Basic response information nullable: true properties: duration: @@ -5122,8 +5602,10 @@ components: required: - push_providers - duration + title: Response type: object ListRolesResponse: + description: Basic response information nullable: true properties: duration: @@ -5139,6 +5621,7 @@ components: required: - roles - duration + title: Response type: object MarkChannelsReadRequest: nullable: true @@ -5234,38 +5717,23 @@ components: - duration type: object Message: - 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: "011" before_message_send_failed: - description: Whether `before_message_send webhook` failed or not. Field - is only accessible in push webhook - title: Before Message Send Failed type: boolean - x-stream-docs-page-id: before_message_send_webhook x-stream-index: "045" cid: - description: Channel unique identifier in : format - title: Channel CID type: string x-stream-index: "027" command: - description: Contains provided slash command - title: Command type: string - x-stream-docs-page-id: custom_commands_webhook x-stream-index: "006" created_at: - description: Date/time of creation format: date-time - title: Created at type: string x-stream-index: "029" custom: @@ -5273,9 +5741,7 @@ components: type: object x-stream-index: "033" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: string x-stream-index: "032" deleted_reply_count: @@ -5283,23 +5749,14 @@ components: type: integer x-stream-index: "022" 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: "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: "043" id: - description: Message ID is unique string identifier of the message - title: ID type: string x-stream-index: "002" image_labels: @@ -5307,22 +5764,16 @@ components: items: type: string type: array - description: Contains image moderation information - title: Image moderation labels type: object x-stream-index: "039" latest_reactions: - description: List of 10 latest reactions to this message items: $ref: '#/components/schemas/Reaction' - title: Latest reactions type: array x-stream-index: "012" mentioned_users: - description: List of mentioned users items: - $ref: '#/components/schemas/UserObject' - title: Mentioned Users + $ref: '#/components/schemas/User' type: array x-stream-index: "042" message_text_updated_at: @@ -5330,77 +5781,46 @@ components: type: string x-stream-index: "051" 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: "005" own_reactions: - description: List of 10 latest reactions of authenticated user to this message items: $ref: '#/components/schemas/Reaction' - title: Own reactions type: array x-stream-index: "013" parent_id: - description: ID of parent message (thread) - title: Parent message ID type: string - x-stream-docs-page-id: threads x-stream-index: "018" 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: "050" pinned: - description: Whether message is pinned or not - title: Pinned type: boolean - x-stream-docs-page-id: pinned_messages x-stream-index: "046" 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: "047" pinned_by: - $ref: '#/components/schemas/UserObject' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages + $ref: '#/components/schemas/User' x-stream-index: "049" poll: $ref: '#/components/schemas/Poll' x-stream-index: "053" poll_id: - description: Identifier of the poll to include in the message - title: Poll ID type: string x-stream-index: "052" quoted_message: $ref: '#/components/schemas/Message' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message x-stream-index: "024" quoted_message_id: - title: ID of quoted message type: string - x-stream-docs-page-id: threads#quote-message x-stream-index: "023" 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: "014" reaction_groups: @@ -5412,70 +5832,38 @@ components: 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: "015" reply_count: - description: Number of replies to this message format: int32 - title: Reply count type: integer x-stream-index: "021" shadowed: - description: Whether the message was shadowed or not - title: Shadowed type: boolean - x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "035" 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: "020" silent: - description: Whether message is silent or not - title: Silent type: boolean x-stream-index: "044" text: - description: Text of the message. Should be empty if `mml` is provided - title: Text type: string x-stream-index: "004" thread_participants: - description: List of users who participate in thread items: - $ref: '#/components/schemas/UserObject' - title: Thread participants + $ref: '#/components/schemas/User' type: array - x-stream-docs-page-id: threads#quote-message x-stream-index: "026" 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: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: string x-stream-index: "030" user: - $ref: '#/components/schemas/UserObject' - description: Sender of the message. Required when using server-side API - title: User object + $ref: '#/components/schemas/User' x-stream-index: "010" required: - id @@ -5498,9 +5886,7 @@ components: - mentioned_users - silent - pinned - title: Message type: object - x-stream-docs-page-id: send_message MessageActionRequest: nullable: true properties: @@ -5665,7 +6051,7 @@ components: ai_moderation_response: $ref: '#/components/schemas/ModerationResponse' description: Response from AI moderation - title: AI moderation response + title: ModerationResponse x-stream-index: "007" blocked_word: description: Word that was blocked @@ -5696,7 +6082,7 @@ components: moderation_thresholds: $ref: '#/components/schemas/Thresholds' description: Thresholds for AI moderation - title: Moderation thresholds + title: Thresholds x-stream-index: "006" updated_at: description: Date/time of the last update @@ -5730,43 +6116,39 @@ components: properties: channel_id: type: string - x-stream-index: "002.002" + x-stream-index: "003" channel_type: type: string - x-stream-index: "002.003" + x-stream-index: "004" cid: type: string - x-stream-index: "002.001" + x-stream-index: "002" created_at: format: date-time type: string - x-stream-index: "005.002" + x-stream-index: "008" last_read_message_id: type: string - x-stream-index: "006" + x-stream-index: "009" team: type: string - x-stream-index: "004.001" + x-stream-index: "006" thread: $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "003.001" + x-stream-index: "005" type: type: string - x-stream-index: "005.001" + x-stream-index: "007" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "001.001" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" required: - cid - channel_id - channel_type - type - created_at - title: MessageReadEvent type: object - x-stream-event-client-type: true - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent MessageRequest: properties: attachments: @@ -5839,20 +6221,31 @@ components: x-stream-index: "020.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: - type: string + description: Channel unique identifier in : format + title: Channel CID + type: string x-stream-index: "021" 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: "022" custom: @@ -5860,7 +6253,9 @@ components: type: object x-stream-index: "025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: string x-stream-index: "024" deleted_reply_count: @@ -5868,14 +6263,23 @@ components: type: integer x-stream-index: "017" 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: "029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001" image_labels: @@ -5883,16 +6287,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "027" 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: "028" message_text_updated_at: @@ -5900,46 +6310,77 @@ components: type: string x-stream-index: "035" 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" 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: "014" 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: "034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "031" 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: "032" 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: "033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "036" quoted_message: $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message x-stream-index: "019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "018" 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: @@ -5951,38 +6392,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "016" shadowed: + description: Whether the message was shadowed or not + title: Shadowed type: boolean + x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "026" 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: "015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "030" 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: "020" 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: "023" 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 @@ -6005,7 +6478,9 @@ components: - mentioned_users - silent - pinned + title: Message type: object + x-stream-docs-page-id: send_message MessageUpdate: properties: change_set: @@ -6016,23 +6491,36 @@ components: x-stream-index: "001" type: object 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.021" 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.022" custom: @@ -6040,7 +6528,9 @@ components: type: object x-stream-index: "001.025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: string x-stream-index: "001.024" deleted_reply_count: @@ -6048,14 +6538,23 @@ components: type: integer x-stream-index: "001.017" 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.029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001.001" image_labels: @@ -6063,16 +6562,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "001.027" 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.028" message_text_updated_at: @@ -6080,46 +6585,77 @@ components: type: string x-stream-index: "001.035" 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" 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.014" 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.034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "001.031" 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.032" 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.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "001.036" 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.019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "001.018" 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: @@ -6131,38 +6667,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "001.016" 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.026" 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.015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "001.030" 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.020" 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.023" 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 @@ -6186,7 +6754,9 @@ components: - silent - pinned - channel + title: Message type: object + x-stream-docs-page-id: send_message ModerationResponse: properties: action: @@ -6392,17 +6962,17 @@ components: properties: banned: type: boolean - x-stream-index: "014" + x-stream-index: "015" blocked_user_ids: items: type: string type: array - x-stream-index: "042" + x-stream-index: "043" channel_mutes: items: $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "027" + x-stream-index: "028" created_at: format: date-time type: string @@ -6414,48 +6984,52 @@ components: deactivated_at: format: date-time type: string - x-stream-index: "012" + x-stream-index: "013" deleted_at: format: date-time type: string - x-stream-index: "011" + x-stream-index: "012" devices: items: $ref: '#/components/schemas/Device' type: array - x-stream-index: "025" + x-stream-index: "026" id: type: string x-stream-index: "003" invisible: type: boolean - x-stream-index: "021" + x-stream-index: "022" language: type: string - x-stream-index: "032" + x-stream-index: "033" last_active: format: date-time type: string x-stream-index: "010" + last_engaged_at: + format: date-time + type: string + x-stream-index: "011" latest_hidden_channels: items: type: string type: array - x-stream-index: "034" + x-stream-index: "035" mutes: items: $ref: '#/components/schemas/UserMute' type: array - x-stream-index: "026" + x-stream-index: "027" online: type: boolean - x-stream-index: "020" + x-stream-index: "021" privacy_settings: $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" + x-stream-index: "025" push_notifications: $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" + x-stream-index: "024" role: type: string x-stream-index: "004" @@ -6463,23 +7037,23 @@ components: items: type: string type: array - x-stream-index: "033" + x-stream-index: "034" total_unread_count: format: int32 type: integer - x-stream-index: "029" + x-stream-index: "030" unread_channels: format: int32 type: integer - x-stream-index: "030" + x-stream-index: "031" unread_count: format: int32 type: integer - x-stream-index: "028" + x-stream-index: "029" unread_threads: format: int32 type: integer - x-stream-index: "031" + x-stream-index: "032" updated_at: format: date-time type: string @@ -6501,6 +7075,132 @@ components: - unread_threads - language type: object + OwnUserResponse: + properties: + banned: + type: boolean + x-stream-index: "001.011" + 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.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: string + x-stream-index: "001.015" + deleted_at: + format: date-time + type: string + x-stream-index: "001.010" + 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.013" + 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.012" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettingsResponse' + x-stream-index: "002" + revoke_tokens_issued_before: + format: date-time + type: string + x-stream-index: "001.014" + role: + type: string + x-stream-index: "001.006" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + 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.009" + 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: @@ -6646,6 +7346,7 @@ components: - updated_at type: object PolicyRequest: + description: Policy request properties: action: enum: @@ -6694,6 +7395,7 @@ components: - roles - owner - priority + title: PolicyRequest type: object Poll: properties: @@ -6717,7 +7419,7 @@ components: type: string x-stream-index: "021" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "020" created_by_id: type: string @@ -6904,7 +7606,7 @@ components: additionalProperties: {} type: object writeOnly: true - x-stream-index: "020" + x-stream-index: "021" allow_answers: type: boolean x-stream-index: "008" @@ -6918,13 +7620,13 @@ components: created_at: format: date-time type: string - x-stream-index: "018" + x-stream-index: "019" created_by: $ref: '#/components/schemas/UserResponse' - x-stream-index: "017" + x-stream-index: "018" created_by_id: type: string - x-stream-index: "016" + x-stream-index: "017" description: type: string x-stream-index: "003" @@ -6937,6 +7639,11 @@ components: 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: @@ -6960,11 +7667,11 @@ components: items: $ref: '#/components/schemas/PollVoteResponseData' type: array - x-stream-index: "015" + x-stream-index: "016" updated_at: format: date-time type: string - x-stream-index: "019" + x-stream-index: "020" vote_count: format: int32 type: integer @@ -6991,6 +7698,7 @@ components: - answers_count - vote_counts_by_option - latest_votes_by_option + - latest_answers - own_votes - created_by_id - created_at @@ -7024,7 +7732,7 @@ components: type: string x-stream-index: "011" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "009" user_id: type: string @@ -7441,24 +8149,74 @@ components: required: - filter_conditions type: object - QueryBannedUsersResponse: + 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: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + type: array + x-stream-index: "002" + type: object + QueryCampaignsResponse: + description: Basic response information nullable: true properties: - bans: - description: List of found bans + campaigns: items: - $ref: '#/components/schemas/BanResponse' - title: BanResponse + $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: - - bans + - campaigns - duration + title: Response type: object QueryChannelsRequest: nullable: true @@ -7537,6 +8295,7 @@ components: title: Channels list type: object QueryMembersPayload: + description: Client request properties: filter_conditions: additionalProperties: {} @@ -7581,6 +8340,7 @@ components: required: - type - filter_conditions + title: ClientRequest type: object QueryMessageFlagsPayload: properties: @@ -7606,7 +8366,7 @@ components: x-stream-index: "002" sort: items: - $ref: '#/components/schemas/SortParam' + $ref: '#/components/schemas/SortParamRequest' maximum: 5 type: array x-stream-index: "003.005" @@ -7618,6 +8378,7 @@ components: x-stream-index: "004.001" type: object QueryMessageFlagsResponse: + description: Query message flags response nullable: true properties: duration: @@ -7635,6 +8396,7 @@ components: required: - flags - duration + title: QueryMessageFlagsResponse type: object QueryMessageHistoryRequest: nullable: true @@ -7812,6 +8574,7 @@ components: x-stream-index: "004.001" type: object QueryReactionsResponse: + description: Basic response information properties: duration: description: Duration of the request in milliseconds @@ -7832,6 +8595,121 @@ components: required: - reactions - duration + title: Response + 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 @@ -7993,14 +8871,11 @@ components: - enabled type: object Reaction: - description: Represents user reaction to a message nullable: true properties: created_at: - description: Date/time of creation format: date-time readOnly: true - title: Created at type: string x-stream-index: "008" custom: @@ -8008,35 +8883,25 @@ components: type: object x-stream-index: "010" message_id: - description: ID of a message user reacted to - title: Message ID type: string x-stream-index: "003" score: - description: Reaction score. If not specified reaction has score of 1 format: int32 - title: Score type: integer x-stream-index: "007" type: - description: The type of reaction (e.g. 'like', 'laugh', 'wow') maxLength: 30 - title: Type type: string x-stream-index: "006" updated_at: - description: Date/time of the last update format: date-time readOnly: true - title: Updated at type: string x-stream-index: "009" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005" user_id: - description: ID of a user who reacted to a message - title: User ID type: string x-stream-index: "004" required: @@ -8046,26 +8911,40 @@ components: - created_at - updated_at - custom - title: Reaction type: object - x-stream-docs-page-id: send_reaction 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: @@ -8073,8 +8952,10 @@ components: - sum_scores - first_reaction_at - last_reaction_at + title: ReactionGroupResponse type: object ReactionRemovalResponse: + description: Basic response information nullable: true properties: duration: @@ -8090,11 +8971,15 @@ components: x-stream-index: "002" required: - duration + title: Response type: object 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: @@ -8102,15 +8987,21 @@ components: 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: @@ -8121,7 +9012,9 @@ components: x-stream-index: "006.001" required: - type + title: Reaction type: object + x-stream-docs-page-id: send_reaction ReactionResponse: properties: created_at: @@ -8214,6 +9107,7 @@ components: - duration type: object ReactivateUsersRequest: + description: Reactivate users in batches nullable: true properties: created_by_id: @@ -8240,8 +9134,10 @@ components: x-stream-index: "001" required: - user_ids + title: ReactivateUsersRequest type: object ReactivateUsersResponse: + description: Basic response information nullable: true properties: duration: @@ -8255,27 +9151,7 @@ components: required: - task_id - duration - type: object - Read: - nullable: true - 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/UserObject' - x-stream-index: "001" - required: - - last_read - - unread_messages + title: Response type: object ReadReceipts: properties: @@ -8329,11 +9205,10 @@ components: type: string x-stream-index: "003" required: - - audio_only - mode - - quality type: object Response: + description: Basic response information nullable: true properties: duration: @@ -8343,6 +9218,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object RestoreUsersRequest: nullable: true @@ -8628,7 +9504,7 @@ components: $ref: '#/components/schemas/UserResponse' x-stream-index: "001.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: type: string @@ -8727,17 +9603,147 @@ components: warning_code: description: Code corresponding to the warning format: int32 - title: Warning Code + 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" - warning_description: - description: Description of the warning - title: Warning Description + target_id: type: string - x-stream-index: "001" + x-stream-index: "003" required: - - warning_description - - warning_code + - app_pk + - segment_id + - target_id + - created_at type: object SendEventRequest: nullable: true @@ -8821,6 +9827,7 @@ components: - reaction type: object SendReactionResponse: + description: Basic response information nullable: true properties: duration: @@ -8838,6 +9845,7 @@ components: - message - reaction - duration + title: Response type: object SendUserCustomEventRequest: nullable: true @@ -8859,6 +9867,7 @@ components: x-stream-index: "002.001" type: object ShowChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -8868,12 +9877,14 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object - SortParam: + SortParamRequest: nullable: true properties: direction: - description: Direction of sorting, -1 for descending, 1 for ascending + description: Direction of sorting, 1 for Ascending, -1 for Descending, default + is 1 format: int32 title: Direction type: integer @@ -8884,21 +9895,36 @@ components: type: string x-stream-index: "001" type: object - SortParamRequest: + StartCampaignRequest: nullable: true properties: - direction: - description: Direction of sorting, 1 for Ascending, -1 for Descending, default - is 1 - format: int32 - title: Direction - type: integer + scheduled_for: + format: date-time + type: string x-stream-index: "002" - field: - description: Name of field to sort by - title: Field + 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: "002.001" + required: + - duration + title: Response + type: object + StopCampaignRequest: + nullable: true type: object TargetResolution: properties: @@ -8932,49 +9958,49 @@ components: format: int32 readOnly: true type: integer - x-stream-index: "002" + x-stream-index: "001" channel_cid: type: string - x-stream-index: "003" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "008" + x-stream-index: "007" custom: additionalProperties: {} type: object - x-stream-index: "011" + x-stream-index: "010" last_read_at: format: date-time type: string - x-stream-index: "010" + x-stream-index: "009" last_thread_message_at: format: date-time type: string - x-stream-index: "004" + 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: "009" + x-stream-index: "008" thread_id: description: Thead ID is unique string identifier of the thread title: ID type: string - x-stream-index: "005" + x-stream-index: "004" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: User is the user object title: User - x-stream-index: "007" + x-stream-index: "006" user_id: description: User ID is unique string identifier of the user title: User ID type: string - x-stream-index: "006" + x-stream-index: "005" required: - app_pk - channel_cid @@ -9008,7 +10034,7 @@ components: type: string x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Created By User title: User x-stream-index: "006" @@ -9036,7 +10062,7 @@ components: type: string x-stream-index: "011" parent_message: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' description: Parent Message title: Message x-stream-index: "004" @@ -9085,6 +10111,7 @@ components: - custom type: object ThreadStateResponse: + nullable: true properties: active_participant_count: description: Active Participant Count @@ -9159,7 +10186,7 @@ components: x-stream-index: "001.008" read: items: - $ref: '#/components/schemas/Read' + $ref: '#/components/schemas/ReadStateResponse' type: array x-stream-index: "003" reply_count: @@ -9197,16 +10224,24 @@ components: - latest_replies 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 ThumbnailsSettings: properties: @@ -9219,7 +10254,11 @@ components: TranscriptionSettings: properties: closed_caption_mode: - title: string + enum: + - available + - disabled + - auto-on + title: Mode type: string x-stream-index: "002" languages: @@ -9231,12 +10270,11 @@ components: type: array x-stream-index: "003" mode: - description: oneof=available disabled auto-on enum: - available - disabled - auto-on - title: string + title: Mode type: string x-stream-index: "001" required: @@ -9428,6 +10466,7 @@ components: x-stream-index: "002.001" type: object UnmuteResponse: + description: Basic response information nullable: true properties: duration: @@ -9442,6 +10481,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object UnmuteUserRequest: nullable: true @@ -9482,6 +10522,7 @@ components: - user_ids type: object UnreadCountsBatchResponse: + description: Basic response information nullable: true properties: counts_by_user: @@ -9497,6 +10538,7 @@ components: required: - counts_by_user - duration + title: Response type: object UnreadCountsChannel: properties: @@ -9793,6 +10835,7 @@ components: user_id: type: string x-stream-index: "003.001" + title: UpdateChannelPartialRequest type: object UpdateChannelPartialResponse: nullable: true @@ -10055,6 +11098,9 @@ components: search: type: boolean x-stream-index: 009.001.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 009.001.028 typing_events: type: boolean x-stream-index: 009.001.002 @@ -10187,6 +11233,9 @@ components: search: type: boolean x-stream-index: 003.001.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.001.028 typing_events: type: boolean x-stream-index: 003.001.002 @@ -10223,13 +11272,13 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - created_at - updated_at - commands - duration type: object UpdateCommandRequest: - description: Represents custom chat command nullable: true properties: args: @@ -10252,19 +11301,22 @@ components: x-stream-index: "004" required: - description - title: Command + 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: nullable: true @@ -10296,6 +11348,7 @@ components: - bucket type: object UpdateExternalStorageResponse: + description: Basic response information nullable: true properties: bucket: @@ -10325,6 +11378,7 @@ components: - bucket - path - duration + title: Response type: object UpdateMemberPartialRequest: nullable: true @@ -10427,6 +11481,7 @@ components: - message type: object UpdateMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -10445,6 +11500,7 @@ components: required: - message - duration + title: Response type: object UpdatePollOptionRequest: nullable: true @@ -10702,6 +11758,7 @@ components: x-stream-index: "001" type: object UpsertPushProviderResponse: + description: Basic response information nullable: true properties: duration: @@ -10715,98 +11772,20 @@ components: required: - push_provider - duration + title: Response type: object - UserCustomEventRequest: - properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "002" - type: - type: string - x-stream-index: "001" - required: - - type - type: object - 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/UserObject' - 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/UserObject' - 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 - UserObject: - description: Represents chat user + User: properties: ban_expires: - description: Expiration date of the ban format: date-time - title: Ban expires type: string - x-stream-index: "015" + x-stream-index: "016" banned: - description: Whether a user is banned or not - title: Banned type: boolean - x-stream-index: "014" + x-stream-index: "015" created_at: - description: Date/time of creation format: date-time readOnly: true - title: Created at type: string x-stream-index: "007" custom: @@ -10814,85 +11793,142 @@ components: type: object x-stream-index: "005" deactivated_at: - description: Date of deactivation format: date-time readOnly: true - title: Deactivated at type: string - x-stream-index: "012" + x-stream-index: "013" deleted_at: - description: Date/time of deletion format: date-time readOnly: true - title: Deleted at type: string - x-stream-index: "011" + x-stream-index: "012" id: - description: Unique user identifier - title: ID type: string x-stream-index: "003" invisible: type: boolean - x-stream-index: "021" + x-stream-index: "022" language: - description: Preferred language of a user - title: Language type: string - x-stream-index: "032" + x-stream-index: "033" last_active: - description: Date of last activity format: date-time readOnly: true - title: Last active type: string x-stream-index: "010" + last_engaged_at: + format: date-time + readOnly: true + type: string + x-stream-index: "011" online: - description: Whether a user online or not readOnly: true - title: Online type: boolean - x-stream-index: "020" + x-stream-index: "021" privacy_settings: $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" + x-stream-index: "025" push_notifications: $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" + x-stream-index: "024" revoke_tokens_issued_before: - description: Revocation date for tokens format: date-time - title: Revoke tokens issued before type: string - x-stream-index: "039" - role: - description: Determines the set of user permissions - title: Role + x-stream-index: "040" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "034" + updated_at: + format: date-time + readOnly: true + type: string + x-stream-index: "008" + required: + - id + - role + - custom + - banned + - online + type: object + UserCustomEventRequest: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "002" + type: + type: string + x-stream-index: "001" + required: + - type + type: object + 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" - teams: - description: List of teams user is a part of - items: - type: string - title: Teams - type: array - x-stream-index: "033" + expires: + format: date-time + type: string + 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 - readOnly: true - title: Updated at type: string - x-stream-index: "008" + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" required: - - id - - role - - custom - - banned - - online - title: User object + - created_at + - updated_at type: object UserRequest: + description: User request object properties: custom: additionalProperties: {} @@ -10920,7 +11956,7 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' @@ -10937,8 +11973,10 @@ components: x-stream-index: "009" required: - id + title: UserRequest type: object UserResponse: + description: User response object properties: ban_expires: description: Date when ban expires @@ -10983,7 +12021,7 @@ components: devices: description: List of devices user is using items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "006" @@ -11073,6 +12111,7 @@ components: - shadow_banned - devices - invisible + title: UserResponse type: object VideoSettings: properties: @@ -11105,7 +12144,7 @@ components: VoteData: properties: Option: - $ref: '#/components/schemas/PollOption' + $ref: '#/components/schemas/PollOptionResponseData' x-stream-index: "003" answer_text: type: string @@ -11120,19 +12159,19 @@ components: properties: automoderation: type: boolean - x-stream-index: "022" + x-stream-index: "021" automoderation_scores: $ref: '#/components/schemas/ModerationResponse' - x-stream-index: "023" + x-stream-index: "022" channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "010" + x-stream-index: "009" channel_id: type: string x-stream-index: "004" channel_type: type: string - x-stream-index: "006" + x-stream-index: "005" cid: type: string x-stream-index: "003" @@ -11142,63 +12181,63 @@ components: created_at: format: date-time type: string - x-stream-index: "027" + x-stream-index: "026" created_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "021" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "020" custom: additionalProperties: {} type: object - x-stream-index: "026" + x-stream-index: "025" me: - $ref: '#/components/schemas/OwnUser' - x-stream-index: "018" + $ref: '#/components/schemas/OwnUserResponse' + x-stream-index: "017" member: $ref: '#/components/schemas/ChannelMember' - x-stream-index: "013" + x-stream-index: "012" message: - $ref: '#/components/schemas/Message' - x-stream-index: "007" + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "006" message_update: $ref: '#/components/schemas/MessageUpdate' - x-stream-index: "008" + x-stream-index: "007" parent_id: type: string - x-stream-index: "024" + x-stream-index: "023" poll: - $ref: '#/components/schemas/Poll' - x-stream-index: "014" + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "013" poll_vote: - $ref: '#/components/schemas/PollVote' - x-stream-index: "015" + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "014" reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "009" + $ref: '#/components/schemas/ReactionResponse' + x-stream-index: "008" reason: type: string - x-stream-index: "020" + x-stream-index: "019" team: type: string - x-stream-index: "025" + x-stream-index: "024" thread: $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "012" + x-stream-index: "011" thread_id: type: string - x-stream-index: "011" + x-stream-index: "010" type: type: string x-stream-index: "001" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "016" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "015" user_id: type: string - x-stream-index: "017" + x-stream-index: "016" watcher_count: format: int32 type: integer - x-stream-index: "019" + x-stream-index: "018" required: - type - custom @@ -11207,6 +12246,7 @@ components: type: object x-stream-docs-page-id: event_object WrappedUnreadCountsResponse: + description: Basic response information nullable: true properties: channel_type: @@ -11244,6 +12284,7 @@ components: - channel_type - threads - duration + title: Response type: object XiaomiConfig: properties: @@ -11313,7 +12354,7 @@ components: type: apiKey info: title: Stream API - version: v133.1.0 + version: v137.0.0 openapi: 3.0.3 paths: /app: @@ -11327,7 +12368,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetApplicationResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11359,7 +12400,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11386,7 +12427,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListBlockListResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11419,7 +12460,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11456,7 +12497,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11492,7 +12533,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetBlockListResponse' - description: Get Block list response + description: GetBlockListResponse "400": content: application/json: @@ -11535,7 +12576,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -11572,7 +12613,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallTokenResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11617,7 +12658,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallTokenResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11633,6 +12674,155 @@ paths: summary: Get Call Token tags: - product: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" + 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 + 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 + 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 + /campaigns/query: + post: + description: | + Query campaigns + 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 campaign + tags: + - product:chat /channels: post: description: | @@ -11711,7 +12901,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11763,6 +12953,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest required: true responses: "200": @@ -11885,7 +13076,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCallResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11940,7 +13131,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EventResponse' - description: Successful response + description: Response "400": content: application/json: @@ -11997,7 +13188,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -12101,7 +13292,7 @@ paths: application/json: schema: $ref: '#/components/schemas/HideChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12158,7 +13349,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -12554,7 +13745,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShowChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12660,7 +13851,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -12816,7 +14007,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListChannelTypesResponse' - description: Successful response + description: ListChannelTypesResponse "400": content: application/json: @@ -12841,6 +14032,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateChannelTypeRequest' + description: CreateChannelTypeRequest required: true responses: "201": @@ -12885,7 +14077,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -12921,7 +14113,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetChannelTypeResponse' - description: Successful response + description: Response "400": content: application/json: @@ -12987,6 +14179,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CheckPushRequest' + description: CheckPushRequest required: true responses: "201": @@ -13087,7 +14280,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListCommandsResponse' - description: Successful response + description: ListCommandsResponse "400": content: application/json: @@ -13112,7 +14305,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCommandRequest' - description: Command + description: CreateCommandRequest required: true responses: "201": @@ -13120,7 +14313,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCommandResponse' - description: Successful response + description: CreateCommandResponse "400": content: application/json: @@ -13146,6 +14339,8 @@ paths: name: name required: true schema: + description: Command name + title: Name type: string x-stream-index: "001" responses: @@ -13154,7 +14349,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCommandResponse' - description: Successful response + description: DeleteCommandResponse "400": content: application/json: @@ -13179,6 +14374,8 @@ paths: name: name required: true schema: + description: Command name + title: Name type: string x-stream-index: "001" responses: @@ -13187,7 +14384,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCommandResponse' - description: Successful response + description: GetCommandResponse "400": content: application/json: @@ -13222,7 +14419,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCommandRequest' - description: Command + description: UpdateCommandRequest required: true responses: "201": @@ -13230,7 +14427,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCommandResponse' - description: Successful response + description: UpdateCommandResponse "400": content: application/json: @@ -13275,7 +14472,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -13310,7 +14507,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListDevicesResponse' - description: Successful response + description: ListDevicesResponse "400": content: application/json: @@ -13335,6 +14532,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": @@ -13342,7 +14540,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -13375,7 +14573,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExportUsersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13472,7 +14670,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13504,7 +14702,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13539,7 +14737,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13579,7 +14777,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13614,7 +14812,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CheckExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13680,7 +14878,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateImportURLResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13707,7 +14905,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListImportsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13739,7 +14937,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateImportResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13774,7 +14972,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetImportResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13869,7 +15067,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13916,7 +15114,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -13967,7 +15165,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14065,7 +15263,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14104,7 +15302,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14155,7 +15353,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendReactionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14215,7 +15413,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactionRemovalResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14316,7 +15514,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryReactionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14364,7 +15562,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14410,7 +15608,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14646,7 +15844,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetRepliesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14733,7 +15931,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -14772,7 +15970,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -14813,7 +16011,7 @@ paths: application/json: schema: $ref: '#/components/schemas/FlagResponse' - description: Successful response + description: Response "400": content: application/json: @@ -14853,7 +16051,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: Successful response + description: QueryMessageFlagsResponse "400": content: application/json: @@ -14970,7 +16168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15009,7 +16207,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15073,7 +16271,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListPermissionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15110,7 +16308,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCustomPermissionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15235,7 +16433,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -15481,7 +16679,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -15648,7 +16846,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListPushProvidersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15680,7 +16878,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpsertPushProviderResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15729,7 +16927,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -15865,7 +17063,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListRolesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15897,7 +17095,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateRoleResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15934,7 +17132,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -15990,6 +17188,237 @@ paths: summary: Search messages tags: - product:chat + /segments/{id}: + delete: + description: | + Delete a segment + 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 + 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 + 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 + 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 + operationId: ControllerNameQuerySegmentTargets + 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 + /segments/query: + post: + description: | + 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 /tasks/{id}: get: description: | @@ -16079,12 +17508,6 @@ paths: type: string writeOnly: true x-stream-index: "001" - - in: query - name: connection_id - schema: - type: string - writeOnly: true - x-stream-index: "003" - in: query name: reply_limit schema: @@ -16197,7 +17620,7 @@ paths: application/json: schema: $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16230,7 +17653,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnreadCountsBatchResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16428,7 +17851,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16602,6 +18025,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeactivateUsersRequest' + description: DeactivateUsersRequest required: true responses: "201": @@ -16609,7 +18033,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeactivateUsersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16675,6 +18099,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactivateUsersRequest' + description: ReactivateUsersRequest required: true responses: "201": @@ -16682,7 +18107,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactivateUsersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16715,7 +18140,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: diff --git a/openapi/clientside-api.json b/openapi/clientside-api.json index 4912b142..7c8cef48 100644 --- a/openapi/clientside-api.json +++ b/openapi/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"},"AWSRekognitionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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":{"nullable":true,"type":"object"},"AcceptCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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/UserObject","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"moderation_enabled":{"type":"boolean","x-stream-index":"043"},"name":{"type":"string","x-stream-index":"001"},"video_provider":{"type":"string","x-stream-index":"038"}},"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"],"type":"object"},"Attachment":{"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"},"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"002"}},"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"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/UserObject","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/UserObject","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"type":"array","x-stream-index":"002"}},"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","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","action"],"type":"object"},"BlockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"BlockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-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"},"BodyguardConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"profile":{"type":"string","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"003"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"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":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"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-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"}},"required":["text","start_time","end_time","speaker_id"],"type":"object"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallEvent":{"nullable":true,"properties":{"additional":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"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":"003"},"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","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","x-stream-index":"001"}},"required":["rtmp"],"title":"Call inputs","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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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"},"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"],"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"},"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"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"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"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"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":{"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRequest":{"properties":{"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"}},"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"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":"020"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"013"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"018"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"022"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"019"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"016"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"014"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"021"},"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","backstage","settings","blocked_user_ids","ingress","egress"],"title":"Call","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-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-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-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-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-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-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-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"},"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"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"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-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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"type":"object"},"CallStateResponseFields":{"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"],"type":"object"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"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"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"truncated_by":{"$ref":"#/components/schemas/UserObject","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":{"description":"Channel configuration overrides","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"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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"},"title":"Grants","type":"object","x-stream-index":"002","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","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-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-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-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/UserObject","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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ChannelMember":{"nullable":true,"properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"017"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"016"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"021"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","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":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"009"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"010"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"008"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"022"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"title":"User ID","type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"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":"016"},"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":"017"},"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":"015"},"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","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/UserObject","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":"021"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"022"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"027"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"Config","x-stream-index":"017"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"024"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/UserObject","description":"Creator of the channel","title":"Created by","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"012"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"026"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"023"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"003"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"006"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"015"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"014"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"019"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"018"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"type":"string"},"title":"Own Capabilities","type":"array","x-stream-index":"025"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"020"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"Truncated At","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"029"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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-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-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-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/UserObject","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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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":["user_session_id","sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["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"},"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"type":"object"},"CreateDeviceRequest":{"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"],"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":"004"},"position":{"format":"int32","type":"integer","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteCallRequest":{"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"}},"type":"object"},"DeleteCallResponse":{"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":"003.001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["call","duration"],"type":"object"},"DeleteChannelResponse":{"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"],"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":{"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"],"type":"object"},"DeleteRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"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":"Device","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"}},"required":["playlist_url"],"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"},"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":{"nullable":true,"type":"object"},"EndCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"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":{"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"],"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":"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/UserObject","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/UserObject","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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"reason":{"type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id","reason"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"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":"003"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"004.002"}},"required":["type","created_at"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"type":"object"},"GetApplicationResponse":{"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"],"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"},"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"],"type":"object"},"GetCallStatsResponse":{"nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"type":"object"},"GetEdgesResponse":{"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"],"type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/Message"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"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"],"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"}},"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"],"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":{"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"],"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_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"type":"object"},"GoLiveResponse":{"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"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"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"],"type":"object"},"HLSSettingsResponse":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"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"},"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"],"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"}},"type":"object"},"HideChannelResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"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"},"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"],"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"],"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":{"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"},"LayoutSettingsRequest":{"properties":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"type":"object"},"ListRecordingsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"items":{"$ref":"#/components/schemas/CallTranscription"},"type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"type":"object"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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/UserObject","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-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":"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MemberRequest":{"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"],"type":"object"},"MemberResponse":{"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"],"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/UserObject","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-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":{"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":"011"},"before_message_send_failed":{"description":"Whether `before_message_send webhook` failed or not. Field is only accessible in push webhook","title":"Before Message Send Failed","type":"boolean","x-stream-docs-page-id":"before_message_send_webhook","x-stream-index":"045"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"027"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"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":"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":"043"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","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":"039"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Latest reactions","type":"array","x-stream-index":"012"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserObject"},"title":"Mentioned Users","type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"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":"005"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Own reactions","type":"array","x-stream-index":"013"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"018"},"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":"050"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"046"},"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":"047"},"pinned_by":{"$ref":"#/components/schemas/UserObject","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"024"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"023"},"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":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"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":"015"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"021"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"035"},"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":"020"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"044"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"004"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserObject"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"026"},"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":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/UserObject","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"010"}},"required":["id","text","html","type","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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-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/UserObject"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":"AI moderation response","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":"Moderation 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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"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"},"last_read_message_id":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"004.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"message.read","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"001.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"MessageReadEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"008"},"cid":{"type":"string","x-stream-index":"021"},"command":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"html":{"type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"029"},"id":{"type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"027"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"mml":{"type":"string","x-stream-index":"003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"010"},"parent_id":{"type":"string","x-stream-index":"014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"034"},"pinned":{"type":"boolean","x-stream-index":"031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"037"},"poll_id":{"type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"019"},"quoted_message_id":{"type":"string","x-stream-index":"018"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"016"},"shadowed":{"type":"boolean","x-stream-index":"026"},"show_in_channel":{"type":"boolean","x-stream-index":"015"},"silent":{"type":"boolean","x-stream-index":"030"},"text":{"type":"string","x-stream-index":"002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"020"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"023"},"user":{"$ref":"#/components/schemas/UserResponse","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"],"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/UserObject"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessageWithChannelResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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","channel"],"type":"object"},"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"},"ModerationConfig":{"nullable":true,"properties":{"async":{"type":"boolean","x-stream-index":"005"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"007"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"008"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"006"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"011"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"009"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"010"},"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"012"},"key":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"013"}},"required":["key","async","created_at","updated_at"],"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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationEvent":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ModerationEventActionLog","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"flags":{"items":{"$ref":"#/components/schemas/ModerationEventFlag"},"type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"review_queue_item":{"$ref":"#/components/schemas/ModerationEventReviewQueueItem","x-stream-index":"001"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"ModerationEventActionLog":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"007"},"type":{"type":"string","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ModerationEventFlag":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"reason":{"type":"string","x-stream-index":"003"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"006"},"type":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user_id","result","created_at","updated_at"],"type":"object"},"ModerationEventReviewQueueItem":{"properties":{"assigned_to":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"010"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"016"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"007"},"recommended_action":{"type":"string","x-stream-index":"009"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"severity":{"format":"int32","type":"integer","x-stream-index":"012"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by"],"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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","type":"object","x-stream-event-client-type":true,"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"},"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"},"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"],"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"],"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"}},"type":"object"},"MuteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-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-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-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-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/UserObject","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-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/UserObject","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-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/UserObject","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-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/UserObject","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-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"},"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/UserObject","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-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-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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"014"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"042"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"027"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"025"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"type":"string","x-stream-index":"032"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"026"},"online":{"type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"033"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"028"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"031"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"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"],"type":"object"},"PinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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/UserObject","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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.closed","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"type":"object"},"PollDeletedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.deleted","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"020"},"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":"018"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"created_by_id":{"type":"string","x-stream-index":"016"},"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_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":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"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","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollUpdatedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.updated","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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/UserObject","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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_casted","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteChangedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_changed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteRemovedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_removed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":{"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"],"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":{"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"],"type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"004"},"watch":{"type":"boolean","x-stream-index":"001"}},"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"],"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"},"QueryMembersPayload":{"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"],"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/SortParam"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"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"],"type":"object"},"QueryModerationConfigsRequest":{"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/SortParamRequest"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"items":{"$ref":"#/components/schemas/ModerationConfig"},"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"},"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":{"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"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"lock_moderator_duration":{"type":"integer","x-stream-index":"004"},"lock_moderator_id":{"type":"string","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"stats_only":{"type":"boolean","x-stream-index":"005"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItem"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"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":{"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"],"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMP Ingress","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"}},"type":"object"},"RTMPSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"type":"object"},"Reaction":{"description":"Represents user reaction to a message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"description":"ID of a message user reacted to","title":"Message ID","type":"string","x-stream-index":"003"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"007"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"description":"ID of a user who reacted to a message","title":"User ID","type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"number","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"number","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"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/UserObject"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionRemovalResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"type":"object"},"ReactionRequest":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"format":"int32","type":"integer","x-stream-index":"002"},"type":{"maxLength":30,"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["type"],"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"},"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Read":{"nullable":true,"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/UserObject","x-stream-index":"001"}},"required":["last_read","unread_messages"],"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":"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"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"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"],"type":"object"},"RecordSettingsResponse":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ReviewQueueItem":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"027"},"assigned_to":{"$ref":"#/components/schemas/UserObject","x-stream-index":"024"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"025"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"016"},"content_changed":{"type":"boolean","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/UserObject","x-stream-index":"023"},"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":"029"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"030"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"022"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"015"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"019"},"reviewed_by":{"type":"string","x-stream-index":"020"},"severity":{"format":"int32","type":"integer","x-stream-index":"018"},"status":{"type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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"},"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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"},"SendCallEventRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, -1 for descending, 1 for ascending","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"},"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"},"StartHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StartHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"playlist_url":{"type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"type":"object"},"StartRTMPBroadcastsRequest":{"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"],"type":"object"},"StartRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StatsOptions":{"properties":{"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"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"],"type":"object"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopLiveRequest":{"nullable":true,"type":"object"},"StopLiveResponse":{"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"],"type":"object"},"StopRTMPBroadcastsRequest":{"nullable":true,"type":"object"},"StopRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopTranscriptionRequest":{"nullable":true,"type":"object"},"StopTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"SyncRequest":{"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"],"type":"object"},"SyncResponse":{"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"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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":"002"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"011"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"010"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"004"},"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":"009"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","description":"User is the user object","title":"User","x-stream-index":"007"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"006"}},"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/UserObject","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/Message","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":{"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"},"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/Read"},"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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/UserObject","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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnblockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"UnblockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-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":{"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"],"type":"object"},"UnpinRequest":{"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"],"type":"object"},"UnpinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"UpdateCallMembersRequest":{"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"}},"type":"object"},"UpdateCallMembersResponse":{"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"],"type":"object"},"UpdateCallRequest":{"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"}},"type":"object"},"UpdateCallResponse":{"description":"Represents 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":"Call","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"}},"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"},"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":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"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"],"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"},"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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/UserObject","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/UserObject","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-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/UserObject","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"image":{"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"004"}},"required":["name","image","custom","roles"],"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/UserObject","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/UserObject","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserObject":{"description":"Represents chat user","properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"015"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"014"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","readOnly":true,"title":"Deactivated at","type":"number","x-stream-index":"012"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","readOnly":true,"title":"Deleted at","type":"number","x-stream-index":"011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"032"},"last_active":{"description":"Date of last activity","format":"date-time","readOnly":true,"title":"Last active","type":"number","x-stream-index":"010"},"online":{"description":"Whether a user online or not","readOnly":true,"title":"Online","type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"039"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"004"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"033"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"title":"User object","type":"object"},"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/UserObject","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"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/UserObject","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-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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"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/UserObject","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-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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"VelocityFilterConfig":{"properties":{"cascading_actions":{"type":"boolean","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules","cascading_actions"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"timeout":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["action","shadow_ban","ip_ban","cascading_threshold","cascading_action"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoResolution","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"VideoResolution":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"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":{"Option":{"$ref":"#/components/schemas/PollOption","x-stream-index":"003"},"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"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"],"type":"object"},"WSChannelEvent":{"description":"The discriminator object for all websocket channel events, it maps events' payload to the final type","discriminator":{"mapping":{"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"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"}]},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"*":"#/components/schemas/AnyEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","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.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.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_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","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.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.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$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/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/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/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/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","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.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_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","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_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","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.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","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","review_queue_item.new":"#/components/schemas/ModerationEvent","review_queue_item.updated":"#/components/schemas/ModerationEvent","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/AnyEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$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/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/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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"],"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":"v133.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":"Successful response"},"400":{"content":{"application/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/chat/channels":{"post":{"description":"Query channels with filter query\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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"}}},"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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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":"Successful response"},"400":{"content":{"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","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":"Successful response"},"400":{"content":{"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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"description":"Successful response"},"400":{"content":{"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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadMessageFlags\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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":"Successful response"},"400":{"content":{"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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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":"Successful response"},"400":{"content":{"application/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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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":"Successful response"},"400":{"content":{"application/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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":"Moderation v2 ban\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":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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 configs","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 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/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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCallStats\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"Call"},"400":{"content":{"application/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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- JoinCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- SendEvent\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"Successful response"},"400":{"content":{"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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateCall\n- JoinCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- EndCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteUsers\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateCallReaction\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListRecordings\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- JoinCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"Successful response"},"400":{"content":{"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}/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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":"Successful response"},"400":{"content":{"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartTranscription\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":"Successful response"},"400":{"content":{"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopRecording\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopTranscription\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListTranscriptions\n","operationId":"ListTranscriptions","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/ListTranscriptionsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCallPermissions\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteRecording\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteTranscription\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://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"},"AWSRekognitionConfig":{"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"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"009"},"target_user_id":{"type":"string","x-stream-index":"010"},"type":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"moderation_enabled":{"type":"boolean","x-stream-index":"043"},"name":{"type":"string","x-stream-index":"001"},"video_provider":{"type":"string","x-stream-index":"038"}},"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"],"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":"021"},"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":"022"},"image_url":{"type":"string","x-stream-index":"011"},"latitude":{"format":"float","type":"number","x-stream-index":"018"},"longitude":{"format":"float","type":"number","x-stream-index":"019"},"og_scrape_url":{"type":"string","x-stream-index":"023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"024"},"pretext":{"type":"string","x-stream-index":"004"},"stopped_sharing":{"type":"boolean","x-stream-index":"020"},"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"},"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"],"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"},"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"},"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":"005"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"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"},"BlockListRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","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-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"},"BodyguardConfig":{"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"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallEvent":{"nullable":true,"properties":{"category":{"type":"string","x-stream-index":"009"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"issue_tags":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"kind":{"type":"string","x-stream-index":"008"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal","kind"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"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":"003"},"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","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"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-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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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"},"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"],"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"},"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"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"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"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"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":{"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"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"},"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-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-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-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-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-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-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-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"},"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"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"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-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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"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"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"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"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_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":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"002.002"}},"required":["type","created_at"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"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":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"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":{"description":"Channel configuration overrides","properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"title":"Grants","type":"object","x-stream-index":"010","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"max_message_length":{"description":"Overrides max message length","format":"int32","maximum":20000,"title":"Max Message Length","type":"integer","x-stream-index":"007"},"quotes":{"description":"Enables message quotes","title":"Quotes","type":"boolean","x-stream-index":"004"},"reactions":{"description":"Enables or disables reactions","title":"Reactions","type":"boolean","x-stream-index":"002"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"003"},"typing_events":{"description":"Enables or disables typing events","title":"Typing events","type":"boolean","x-stream-index":"001"},"uploads":{"description":"Enables or disables file uploads","title":"Uploads","type":"boolean","x-stream-index":"005"},"url_enrichment":{"description":"Enables or disables URL enrichment","title":"URL Enrichment","type":"boolean","x-stream-index":"006"}},"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.028"},"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"}},"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","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-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-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-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-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-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":{"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","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-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","create-call","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-call","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-typing-events","set-channel-cooldown","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"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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":["user_session_id","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"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key","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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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":"004"},"position":{"format":"int32","type":"integer","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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"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"},"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"},"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"}},"required":["playlist_url"],"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"},"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"},"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":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.016"},"banned":{"type":"boolean","x-stream-index":"001.015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"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.022"},"language":{"type":"string","x-stream-index":"001.033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"001.024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.040"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"}},"required":["id","role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"description":"User response object","properties":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.001.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.001.010"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.001.013"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.001.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.001.014"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.001.007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible","ban_count","deleted_content_count"],"title":"UserResponse","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"},"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":"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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"Flag2Response":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"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_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["user_id","entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"reason":{"maxLength":255,"type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"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":"002.001"},"item_id":{"type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"title":"Response","type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"004.002"}},"required":["type","created_at"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"},"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"},"GetCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"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.021"},"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.022"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"latitude":{"format":"float","type":"number","x-stream-index":"001.018"},"longitude":{"format":"float","type":"number","x-stream-index":"001.019"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.024"},"pretext":{"type":"string","x-stream-index":"001.004"},"stopped_sharing":{"type":"boolean","x-stream-index":"001.020"},"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_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"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"}},"required":["enabled"],"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"},"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"],"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"}},"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"},"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"},"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"},"LayoutSettingsRequest":{"properties":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"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"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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-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":"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-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-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":"011"},"before_message_send_failed":{"type":"boolean","x-stream-index":"045"},"cid":{"type":"string","x-stream-index":"027"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"043"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"039"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"012"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"mml":{"type":"string","x-stream-index":"005"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"parent_id":{"type":"string","x-stream-index":"018"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"050"},"pinned":{"type":"boolean","x-stream-index":"046"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"047"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"024"},"quoted_message_id":{"type":"string","x-stream-index":"023"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"021"},"shadowed":{"type":"boolean","x-stream-index":"035"},"show_in_channel":{"type":"boolean","x-stream-index":"020"},"silent":{"type":"boolean","x-stream-index":"044"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"026"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"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":"008"},"last_read_message_id":{"type":"string","x-stream-index":"009"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"005"},"type":{"default":"message.read","type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["cid","channel_id","channel_type","type","created_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":25,"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":"038"},"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":{"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":"021"},"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":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"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":"029"},"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":"027"},"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":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"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"},"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":"014"},"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":"034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"031"},"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":"032"},"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":"033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"018"},"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":"013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"016"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"026"},"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":"015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"030"},"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":"020"},"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":"023"},"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"],"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-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-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-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.021"},"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.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"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.029"},"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.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"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"},"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.014"},"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.034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.031"},"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.032"},"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.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.036"},"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.019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.018"},"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.013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.016"},"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.026"},"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.015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.030"},"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.020"},"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.023"},"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","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationEvent":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"flags":{"items":{"$ref":"#/components/schemas/Flag2Response"},"type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"001"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"002.002"}},"required":["type","created_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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"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"},"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-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-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-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-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-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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"043"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"026"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"011"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"027"},"online":{"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"031"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"032"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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"},"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-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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.closed","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"type":"object"},"PollDeletedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.deleted","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"021"},"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"},"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":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"002.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.003.004"},"type":{"default":"poll.updated","type":"string","x-stream-index":"002.003.002"}},"required":["poll","cid","type","created_at"],"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"},"PollVoteCastedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_casted","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteChangedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_changed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_at"],"type":"object"},"PollVoteRemovedEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003.003"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.003.004"},"type":{"default":"poll.vote_removed","type":"string","x-stream-index":"003.003.002"}},"required":["poll","poll_vote","cid","type","created_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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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"},"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"},"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":{},"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/SortParamRequest"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"description":"Basic response information","nullable":true,"properties":{"configs":{"items":{"$ref":"#/components/schemas/ConfigResponse"},"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"],"title":"Response","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"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"format":"int32","maximum":25,"minimum":1,"type":"integer","x-stream-index":"005"},"lock_duration":{"type":"integer","x-stream-index":"004"},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"stats_only":{"type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"description":"Basic response information","nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"title":"Response","type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"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"},"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"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ReactionRemovalResponse":{"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/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"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-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"},"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"},"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":"028"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"025"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"026"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"017"},"content_changed":{"type":"boolean","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"024"},"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":"030"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"031"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"027"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"023"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"016"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"020"},"reviewed_by":{"type":"string","x-stream-index":"021"},"severity":{"format":"int32","type":"integer","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"015"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"type":"array","x-stream-index":"020"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"018"},"completed_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","x-stream-index":"015"},"entity_creator_id":{"type":"string","x-stream-index":"016"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"021"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"022"},"flags":{"items":{"$ref":"#/components/schemas/Flag2Response"},"type":"array","x-stream-index":"019"},"id":{"type":"string","x-stream-index":"001"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"008"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"010"},"reviewed_by":{"type":"string","x-stream-index":"011"},"severity":{"format":"int32","type":"integer","x-stream-index":"013"},"status":{"type":"string","x-stream-index":"007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","bans","flags","actions"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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"},"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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"},"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"},"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,"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartTranscriptionRequest","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":{"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms"],"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,"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"},"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,"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,"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":{"enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock"],"type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","x-stream-index":"006"},"item_id":{"type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"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"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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"},"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-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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"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"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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-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-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-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"},"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"},"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":"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"ban_expires":{"format":"date-time","type":"number","x-stream-index":"016"},"banned":{"type":"boolean","x-stream-index":"015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"040"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"}},"required":["id","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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"002"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"005"}},"required":["id","name","image","custom","roles"],"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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"VelocityFilterConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"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"],"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"},"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"}},"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"],"type":"object"},"VideoDimension":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoDimension","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"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":{"Option":{"$ref":"#/components/schemas/PollOptionResponseData","x-stream-index":"003"},"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"},"WSChannelEvent":{"description":"The discriminator object for all websocket channel events, it maps events' payload to the final type","discriminator":{"mapping":{"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"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"}]},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"*":"#/components/schemas/AnyEvent","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.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.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.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_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","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.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.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","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.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AnyEvent"},{"$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/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/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/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/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/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","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.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.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_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","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_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","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.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","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","review_queue_item.new":"#/components/schemas/ModerationEvent","review_queue_item.updated":"#/components/schemas/ModerationEvent","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/AnyEvent"},{"$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/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/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/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$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/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$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.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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":"v137.0.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/chat/channels":{"post":{"description":"Query channels with filter query\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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","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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","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\nRequired permissions:\n- ReadMessageFlags\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Moderation v2 ban\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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":"Response"},"400":{"content":{"application/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 configs","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\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":"Moderation v2 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":"Response"},"400":{"content":{"application/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":"Moderation v2 submit action\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 submit 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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- ReadCallStats\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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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\nRequired permissions:\n- JoinCall\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- DeleteCall\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\nRequired permissions:\n- SendEvent\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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- JoinCall\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\nRequired permissions:\n- EndCall\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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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\nRequired permissions:\n- MuteUsers\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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- CreateCallReaction\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\nRequired permissions:\n- ListRecordings\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\nRequired permissions:\n- JoinCall\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}/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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StartClosedCaptions\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"}}],"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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\nRequired permissions:\n- StartTranscription\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"}}},"description":"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopClosedCaptions\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"}}],"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"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\nRequired permissions:\n- StopRecording\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\nRequired permissions:\n- StopTranscription\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"}}],"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\nRequired permissions:\n- ListTranscriptions\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- UpdateCallPermissions\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\nRequired permissions:\n- DeleteRecording\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\nRequired permissions:\n- DeleteTranscription\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\nRequired permissions:\n- ReadCall\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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/clientside-api.yaml b/openapi/clientside-api.yaml index 07810513..f57b5189 100644 --- a/openapi/clientside-api.yaml +++ b/openapi/clientside-api.yaml @@ -61,14 +61,17 @@ components: type: object AWSRekognitionConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -97,16 +100,22 @@ components: - 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 @@ -158,7 +167,7 @@ components: type: string x-stream-index: "012" target_user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "013" target_user_id: type: string @@ -167,7 +176,7 @@ components: type: string x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "007" required: - id @@ -179,6 +188,50 @@ components: - target_user_id - review_queue_item_id type: object + ActionLogResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "002" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + id: + type: string + x-stream-index: "001" + reason: + type: string + x-stream-index: "006" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "008" + target_user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "009" + target_user_id: + type: string + x-stream-index: "010" + type: + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "005" + required: + - id + - created_at + - type + - user_id + - reason + - custom + - target_user_id + type: object AggregatedStats: properties: countrywise_aggregate_stats: @@ -272,6 +325,8 @@ components: - moderation_enabled type: object Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. nullable: true properties: actions: @@ -297,7 +352,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "018" + x-stream-index: "021" fallback: type: string x-stream-index: "002" @@ -314,24 +369,35 @@ components: x-stream-index: "014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "019" + x-stream-index: "022" image_url: type: string x-stream-index: "011" + latitude: + format: float + type: number + x-stream-index: "018" + longitude: + format: float + type: number + x-stream-index: "019" og_scrape_url: type: string - x-stream-index: "020" + x-stream-index: "023" original_height: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "025" original_width: format: int32 type: integer - x-stream-index: "021" + x-stream-index: "024" pretext: type: string x-stream-index: "004" + stopped_sharing: + type: boolean + x-stream-index: "020" text: type: string x-stream-index: "010" @@ -439,14 +505,17 @@ components: type: object AutomodPlatformCircumventionConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -476,14 +545,17 @@ components: type: object AutomodSemanticFiltersConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -513,14 +585,17 @@ components: type: object AutomodToxicityConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -558,7 +633,7 @@ components: type: number x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "011" expires: format: date-time @@ -571,12 +646,31 @@ components: type: boolean x-stream-index: "009" target: - $ref: '#/components/schemas/UserObject' + $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" + 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: "005" + type: object BanRequest: nullable: true properties: @@ -639,14 +733,17 @@ components: type: object BlockListConfig: properties: - enabled: + async: type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" rules: items: $ref: '#/components/schemas/BlockListRule' type: array - x-stream-index: "002" + x-stream-index: "003" required: - enabled - rules @@ -654,13 +751,17 @@ components: 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: @@ -684,6 +785,7 @@ components: - action type: object BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. nullable: true properties: user_id: @@ -693,8 +795,10 @@ components: 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: @@ -704,6 +808,7 @@ components: x-stream-index: "001.001" required: - duration + title: BlockUserResponse type: object BlockUsersRequest: nullable: true @@ -821,22 +926,25 @@ components: type: object BodyguardConfig: properties: - enabled: + async: type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" profile: type: string - x-stream-index: "002" + x-stream-index: "003" rules: items: $ref: '#/components/schemas/BodyguardRule' type: array - x-stream-index: "003" + x-stream-index: "004" severity_rules: items: $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "004" + x-stream-index: "005" required: - enabled - profile @@ -899,20 +1007,25 @@ components: 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 @@ -971,12 +1084,94 @@ components: 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-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-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-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 @@ -1089,10 +1284,9 @@ components: CallEvent: nullable: true properties: - additional: - additionalProperties: {} - type: object - x-stream-index: "008" + category: + type: string + x-stream-index: "009" component: type: string x-stream-index: "007" @@ -1106,6 +1300,14 @@ components: internal: type: boolean x-stream-index: "006" + issue_tags: + items: + type: string + type: array + x-stream-index: "010" + kind: + type: string + x-stream-index: "008" severity: format: int32 type: integer @@ -1124,6 +1326,7 @@ components: - description - type - internal + - kind type: object CallHLSBroadcastingFailedEvent: description: This event is sent when HLS broadcasting has failed @@ -1208,13 +1411,15 @@ components: 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: Call inputs + title: CallIngressResponse type: object CallLiveStartedEvent: description: This event is sent when a call is started. Clients receiving this @@ -1602,6 +1807,7 @@ components: - url - start_time - end_time + title: CallRecording type: object CallRecordingFailedEvent: description: This event is sent when call recording has failed @@ -1749,6 +1955,7 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent CallRequest: + description: CallRequest is the payload for creating a call. properties: custom: additionalProperties: {} @@ -1773,18 +1980,22 @@ components: video: type: boolean x-stream-index: "008" + title: CallRequest type: object CallResponse: description: Represents a call properties: backstage: type: boolean - x-stream-index: "015" + x-stream-index: "016" blocked_user_ids: items: type: string type: array - x-stream-index: "017" + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" cid: description: The unique identifier for a call (:) title: CID @@ -1812,13 +2023,13 @@ components: x-stream-index: "008" egress: $ref: '#/components/schemas/EgressResponse' - x-stream-index: "020" + x-stream-index: "021" ended_at: description: Date/time when the call ended format: date-time title: Ended At type: number - x-stream-index: "013" + x-stream-index: "014" id: description: Call ID title: ID @@ -1826,32 +2037,32 @@ components: x-stream-index: "003" ingress: $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "018" + x-stream-index: "019" join_ahead_time_seconds: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "023" recording: type: boolean x-stream-index: "011" session: $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "019" + x-stream-index: "020" settings: $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "016" + 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: "014" + x-stream-index: "015" team: type: string x-stream-index: "006" thumbnails: $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "021" + x-stream-index: "022" transcribing: type: boolean x-stream-index: "012" @@ -1877,12 +2088,13 @@ components: - updated_at - recording - transcribing + - captioning - backstage - settings - blocked_user_ids - ingress - egress - title: Call + title: CallResponse type: object CallRingEvent: description: This event is sent to all call members to notify they are getting @@ -2392,6 +2604,7 @@ components: - limits type: object CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response properties: call: $ref: '#/components/schemas/CallResponse' @@ -2418,6 +2631,7 @@ components: - members - own_capabilities - blocked_users + title: CallStateResponseFields type: object CallStatsReportSummaryResponse: properties: @@ -2489,6 +2703,7 @@ components: - url - start_time - end_time + title: CallTranscription type: object CallTranscriptionFailedEvent: description: This event is sent when call transcription has failed @@ -2909,7 +3124,7 @@ components: $ref: '#/components/schemas/ChannelConfig' x-stream-index: "025" config_overrides: - $ref: '#/components/schemas/ChannelConfig' + $ref: '#/components/schemas/ConfigOverrides' x-stream-index: "026" cooldown: format: int32 @@ -2920,7 +3135,7 @@ components: type: number x-stream-index: "009" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "008" custom: additionalProperties: {} @@ -2961,7 +3176,7 @@ components: type: string x-stream-index: "027" truncated_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "015" type: type: string @@ -2994,8 +3209,10 @@ components: type: string x-stream-index: "009" commands: + description: List of commands that channel supports items: type: string + title: Commands type: array x-stream-index: "011" grants: @@ -3107,13 +3324,8 @@ components: items: type: string type: array - title: Grants type: object x-stream-index: "002" - x-stream-map: - description: List of grants modifiers that apply to a role - key: role - title: Grants mark_messages_pending: type: boolean x-stream-index: 001.002.015 @@ -3162,6 +3374,9 @@ components: search: type: boolean x-stream-index: 001.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.028 typing_events: type: boolean x-stream-index: 001.002.002 @@ -3198,6 +3413,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands type: object ChannelCreatedEvent: @@ -3359,7 +3575,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - clear_history @@ -3469,82 +3685,101 @@ components: 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: "017" + x-stream-index: "013" banned: description: Whether member is banned this channel or not title: Banned type: boolean - x-stream-index: "016" + x-stream-index: "012" channel_role: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "021" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "012" + x-stream-index: "009" custom: additionalProperties: {} type: object - x-stream-index: "006" + x-stream-index: "004" deleted_at: format: date-time type: number - x-stream-index: "014" + 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: "009" + 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: "010" + x-stream-index: "007" invited: description: Whether member was invited or not title: Invited type: boolean - x-stream-index: "008" + x-stream-index: "005" is_moderator: description: Whether member is channel moderator or not title: Is moderator type: boolean - x-stream-index: "007" + x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "022" + 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: "019" + x-stream-index: "014" status: type: string - x-stream-index: "011" + x-stream-index: "008" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "013" + x-stream-index: "010" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "005" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" user_id: title: User ID type: string - x-stream-index: "004" + x-stream-index: "001" required: - custom - created_at @@ -3556,8 +3791,11 @@ components: 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 @@ -3573,7 +3811,7 @@ components: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "016" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time @@ -3612,7 +3850,11 @@ components: x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "017" + 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)' @@ -3623,7 +3865,7 @@ components: - owner title: Role type: string - x-stream-index: "015" + x-stream-index: "017" shadow_banned: description: Whether member is shadow banned in this channel or not title: Shadow banned @@ -3674,30 +3916,30 @@ components: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "007" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "009" + x-stream-index: "004" expires: description: Date/time of mute expiration format: date-time title: Expires type: number - x-stream-index: "008" + x-stream-index: "003" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "010" + x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Owner of channel mute title: User - x-stream-index: "005" + x-stream-index: "001" required: - created_at - updated_at @@ -3720,6 +3962,47 @@ components: x-stream-event-client-type: true 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 + - create-call + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-call + - 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-typing-events + - set-channel-cooldown + - 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: @@ -3727,141 +4010,143 @@ components: description: Whether auto translation is enabled or not title: Auto translation type: boolean - x-stream-index: "021" + 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: "022" + x-stream-index: "018" blocked: description: Whether this channel is blocked by current user or not title: Blocked type: boolean - x-stream-index: "027" + x-stream-index: "023" cid: description: Channel CID (:) title: CID type: string - x-stream-index: "005" + x-stream-index: "003" config: $ref: '#/components/schemas/ChannelConfigWithInfo' description: Channel configuration - title: Config - x-stream-index: "017" + title: ChannelConfigWithInfo + x-stream-index: "013" cooldown: description: Cooldown period after sending each message format: int32 title: Cooldown type: integer - x-stream-index: "024" + x-stream-index: "020" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "008" + x-stream-index: "005" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Creator of the channel - title: Created by - x-stream-index: "011" + title: UserResponse + x-stream-index: "008" custom: additionalProperties: {} + description: Custom data for this object + title: Custom data type: object - x-stream-index: "030" + x-stream-index: "026" deleted_at: description: Date/time of deletion format: date-time title: Deleted at type: number - x-stream-index: "010" + x-stream-index: "007" disabled: type: boolean - x-stream-index: "013" + x-stream-index: "010" frozen: description: Whether channel is frozen or not title: Frozen type: boolean - x-stream-index: "012" + x-stream-index: "009" hidden: description: Whether this channel is hidden by current user or not title: Hidden type: boolean - x-stream-index: "026" + 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: "023" + x-stream-index: "019" id: description: Channel unique ID title: ID type: string - x-stream-index: "003" + 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: "006" + x-stream-index: "004" member_count: description: Number of members in the channel format: int32 title: Member count type: integer - x-stream-index: "015" + x-stream-index: "012" members: description: List of channel members (max 100) items: $ref: '#/components/schemas/ChannelMember' - title: Members + title: ChannelMembers type: array - x-stream-index: "014" + x-stream-index: "011" mute_expires_at: description: Date of mute expiration format: date-time title: Mute expires at type: number - x-stream-index: "019" + x-stream-index: "015" muted: description: Whether this channel is muted or not title: Muted type: boolean - x-stream-index: "018" + x-stream-index: "014" own_capabilities: description: List of channel capabilities of authenticated user items: - type: string - title: Own Capabilities + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability type: array - x-stream-index: "025" + x-stream-index: "021" team: description: Team the channel belongs to (multi-tenant only) title: Team type: string - x-stream-index: "020" + x-stream-index: "016" truncated_at: description: Date of the latest truncation of the channel format: date-time - title: Truncated At + title: UserResponse type: number - x-stream-index: "028" + x-stream-index: "024" truncated_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "029" + $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: "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: "009" + x-stream-index: "006" required: - id - type @@ -4141,7 +4426,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005.001" required: - type @@ -4175,7 +4460,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - cid @@ -4256,6 +4541,7 @@ components: - rating type: object CollectUserFeedbackResponse: + description: Basic response information nullable: true properties: duration: @@ -4265,6 +4551,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Command: description: Represents custom chat command @@ -4311,6 +4598,102 @@ components: - 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" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + required: + - grants + - commands + type: object + ConfigResponse: + properties: + async: + type: boolean + x-stream-index: "002" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + x-stream-index: "004" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + x-stream-index: "005" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + x-stream-index: "003" + aws_rekognition_config: + $ref: '#/components/schemas/AWSRekognitionConfig' + x-stream-index: "009" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + x-stream-index: "006" + bodyguard_config: + $ref: '#/components/schemas/BodyguardConfig' + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "011" + google_vision_config: + $ref: '#/components/schemas/GoogleVisionConfig' + x-stream-index: "008" + key: + type: string + x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "012" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + x-stream-index: "010" + required: + - key + - async + - created_at + - updated_at + type: object ConnectUserDetailsRequest: properties: custom: @@ -4333,7 +4716,7 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' @@ -4453,6 +4836,7 @@ components: x-stream-index: "004" type: object CreateDeviceRequest: + description: Create device request nullable: true properties: id: @@ -4485,6 +4869,7 @@ components: required: - id - push_provider + title: CreateDeviceRequest type: object CreateGuestRequest: nullable: true @@ -4622,6 +5007,16 @@ components: - 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. @@ -4667,7 +5062,14 @@ components: 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: @@ -4676,26 +5078,30 @@ components: 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: - description: Duration of the request in milliseconds - title: 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: @@ -4708,6 +5114,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteChannelsRequest: nullable: true @@ -4762,7 +5169,14 @@ components: 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: @@ -4776,34 +5190,104 @@ components: required: - message - duration + title: Response + type: object + DeleteReactionRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" 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 - Device: - nullable: true + DeleteUserRequest: properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" + 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 @@ -4844,7 +5328,7 @@ components: - id - created_at - user_id - title: Device + title: DeviceResponse type: object EdgeResponse: properties: @@ -4940,16 +5424,22 @@ components: - 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 EnrichedActivity: properties: @@ -5065,6 +5555,214 @@ components: - activity_id - user_id type: object + EntityCreator: + properties: + ban_count: + format: int32 + type: integer + x-stream-index: "002" + ban_expires: + format: date-time + type: number + x-stream-index: "001.016" + banned: + type: boolean + x-stream-index: "001.015" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.007" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.005" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + 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.022" + language: + type: string + x-stream-index: "001.033" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.010" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + online: + readOnly: true + type: boolean + x-stream-index: "001.021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "001.024" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.040" + role: + type: string + x-stream-index: "001.004" + teams: + items: + type: string + type: array + x-stream-index: "001.034" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + required: + - id + - role + - custom + - banned + - online + - ban_count + - deleted_content_count + type: object + EntityCreatorResponse: + description: User response object + properties: + ban_count: + format: int32 + type: integer + x-stream-index: "002" + banned: + description: Whether a user is banned or not + title: Banned + type: boolean + x-stream-index: 001.001.011 + blocked_user_ids: + items: + type: string + type: array + x-stream-index: 001.001.016 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.008 + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: 001.001.004 + deactivated_at: + description: Date of deactivation + format: date-time + title: Deactivated at + type: number + x-stream-index: 001.001.015 + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: 001.001.010 + deleted_content_count: + format: int32 + type: integer + x-stream-index: "003" + id: + description: Unique user identifier + title: ID + type: string + x-stream-index: 001.001.001 + image: + title: Image + type: string + x-stream-index: 001.001.003 + language: + description: Preferred language of a user + title: Language + type: string + x-stream-index: 001.001.005 + last_active: + description: Date of last activity + format: date-time + title: Last active + type: number + x-stream-index: 001.001.013 + name: + description: Optional name of user + title: Name + type: string + x-stream-index: 001.001.002 + online: + description: Whether a user online or not + title: Online + type: boolean + x-stream-index: 001.001.012 + revoke_tokens_issued_before: + description: Revocation date for tokens + format: date-time + title: Revoke tokens issued before + type: number + x-stream-index: 001.001.014 + role: + description: Determines the set of user permissions + title: Role + type: string + x-stream-index: 001.001.006 + teams: + description: List of teams user is a part of + items: + type: string + title: Teams + type: array + x-stream-index: 001.001.007 + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: 001.001.009 + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - devices + - invisible + - ban_count + - deleted_content_count + title: UserResponse + type: object EventRequest: properties: custom: @@ -5081,6 +5779,7 @@ components: - type type: object EventResponse: + description: Basic response information nullable: true properties: duration: @@ -5094,6 +5793,7 @@ components: required: - event - duration + title: Response type: object Field: nullable: true @@ -5236,7 +5936,7 @@ components: type: string x-stream-index: "007" target_user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: Flagged user title: User x-stream-index: "010" @@ -5247,7 +5947,7 @@ components: type: number x-stream-index: "012" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: User who flagged a message or a user title: User x-stream-index: "006" @@ -5308,7 +6008,7 @@ components: type: number x-stream-index: "018" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "006" required: - entity_type @@ -5317,19 +6017,80 @@ components: - created_at - updated_at type: object - FlagDetails: + Flag2Response: + nullable: true properties: - Extra: + created_at: + format: date-time + type: number + x-stream-index: "014" + custom: additionalProperties: {} type: object - writeOnly: true - x-stream-index: "002" - automod: - $ref: '#/components/schemas/AutomodDetails' - x-stream-index: "001" - original_text: + x-stream-index: "010" + entity_creator_id: type: string - x-stream-index: "003" + 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_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "015" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + 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 @@ -5388,14 +6149,15 @@ components: $ref: '#/components/schemas/ModerationPayload' x-stream-index: "005" reason: + maxLength: 255 type: string x-stream-index: "004" required: - entity_type - entity_id - - reason type: object FlagResponse: + description: Basic response information nullable: true properties: duration: @@ -5409,6 +6171,7 @@ components: required: - item_id - duration + title: Response type: object FlagUpdatedEvent: nullable: true @@ -5471,7 +6234,7 @@ components: x-stream-index: "001.010" devices: items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' type: array x-stream-index: "004" id: @@ -5634,6 +6397,7 @@ components: - accuracy_radius type: object GetApplicationResponse: + description: Basic response information nullable: true properties: app: @@ -5647,6 +6411,7 @@ components: required: - app - duration + title: Response type: object GetBlockedUsersResponse: nullable: true @@ -5695,8 +6460,10 @@ components: - own_capabilities - blocked_users - duration + title: GetCallResponse type: object GetCallStatsResponse: + description: Basic response information nullable: true properties: aggregated: @@ -5769,8 +6536,10 @@ components: - max_freezes_duration_seconds - sfus - participant_report + title: Response type: object GetEdgesResponse: + description: Basic response information nullable: true properties: duration: @@ -5786,6 +6555,7 @@ components: required: - edges - duration + title: Response type: object GetManyMessagesResponse: nullable: true @@ -5796,7 +6566,7 @@ components: messages: description: List of messages items: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' title: Messages type: array x-stream-index: "001.001" @@ -5805,6 +6575,7 @@ components: - duration type: object GetMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -5823,6 +6594,7 @@ components: required: - message - duration + title: Response type: object GetOGResponse: nullable: true @@ -5856,7 +6628,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "001.018" + x-stream-index: "001.021" duration: type: string x-stream-index: "002.001" @@ -5876,28 +6648,39 @@ components: x-stream-index: "001.014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "001.019" + x-stream-index: "001.022" image_url: description: URL of detected image title: Image URL type: string x-stream-index: "001.011" + latitude: + format: float + type: number + x-stream-index: "001.018" + longitude: + format: float + type: number + x-stream-index: "001.019" og_scrape_url: description: extracted url from the text title: OG Scrape URL type: string - x-stream-index: "001.020" + x-stream-index: "001.023" original_height: format: int32 type: integer - x-stream-index: "001.022" + x-stream-index: "001.025" original_width: format: int32 type: integer - x-stream-index: "001.021" + x-stream-index: "001.024" pretext: type: string x-stream-index: "001.004" + stopped_sharing: + type: boolean + x-stream-index: "001.020" text: description: og:description title: Text @@ -5955,6 +6738,7 @@ components: video: type: boolean x-stream-index: "006" + title: GetOrCreateCallRequest type: object GetOrCreateCallResponse: nullable: true @@ -5988,6 +6772,7 @@ components: - blocked_users - created - duration + title: GetOrCreateCallResponse type: object GetReactionsResponse: nullable: true @@ -6007,6 +6792,7 @@ components: - duration type: object GetRepliesResponse: + description: Basic response information nullable: true properties: duration: @@ -6022,6 +6808,7 @@ components: required: - messages - duration + title: Response type: object GetThreadResponse: nullable: true @@ -6059,8 +6846,10 @@ components: transcription_storage_name: type: string x-stream-index: "006" + title: GoLiveRequest type: object GoLiveResponse: + description: Basic response information nullable: true properties: call: @@ -6074,6 +6863,7 @@ components: required: - call - duration + title: Response type: object GoogleVisionConfig: properties: @@ -6100,18 +6890,23 @@ components: 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: @@ -6119,6 +6914,7 @@ components: - enabled - quality_tracks - layout + title: HLSSettingsResponse type: object HealthCheckEvent: nullable: true @@ -6159,6 +6955,7 @@ components: x-stream-index: "001" type: object HideChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -6168,6 +6965,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object ICEServer: properties: @@ -6362,6 +7160,7 @@ components: x-stream-index: "006" required: - location + title: JoinCallRequest type: object JoinCallResponse: nullable: true @@ -6405,6 +7204,7 @@ components: - credentials - stats_options - duration + title: JoinCallResponse type: object Label: properties: @@ -6428,15 +7228,19 @@ components: 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 @@ -6488,12 +7292,13 @@ components: x-stream-index: "001" type: object ListDevicesResponse: + description: List devices response nullable: true properties: devices: description: List of devices items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "001" @@ -6503,8 +7308,10 @@ components: required: - devices - duration + title: ListDevicesResponse type: object ListRecordingsResponse: + description: Response for listing recordings nullable: true properties: duration: @@ -6513,11 +7320,13 @@ components: 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 @@ -6526,13 +7335,16 @@ components: 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 Location: properties: @@ -6592,6 +7404,17 @@ components: 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: @@ -6652,7 +7475,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005.001" required: - type @@ -6688,7 +7511,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -6702,6 +7525,7 @@ components: 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: {} @@ -6720,8 +7544,10 @@ components: 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 @@ -6763,6 +7589,7 @@ components: - custom - created_at - updated_at + title: MemberResponse type: object MemberUpdatedEvent: properties: @@ -6790,7 +7617,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -6823,38 +7650,23 @@ components: - duration type: object Message: - 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: "011" before_message_send_failed: - description: Whether `before_message_send webhook` failed or not. Field - is only accessible in push webhook - title: Before Message Send Failed type: boolean - x-stream-docs-page-id: before_message_send_webhook x-stream-index: "045" cid: - description: Channel unique identifier in : format - title: Channel CID type: string x-stream-index: "027" command: - description: Contains provided slash command - title: Command type: string - x-stream-docs-page-id: custom_commands_webhook x-stream-index: "006" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "029" custom: @@ -6862,9 +7674,7 @@ components: type: object x-stream-index: "033" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: number x-stream-index: "032" deleted_reply_count: @@ -6872,23 +7682,14 @@ components: type: integer x-stream-index: "022" 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: "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: "043" id: - description: Message ID is unique string identifier of the message - title: ID type: string x-stream-index: "002" image_labels: @@ -6896,22 +7697,16 @@ components: items: type: string type: array - description: Contains image moderation information - title: Image moderation labels type: object x-stream-index: "039" latest_reactions: - description: List of 10 latest reactions to this message items: $ref: '#/components/schemas/Reaction' - title: Latest reactions type: array x-stream-index: "012" mentioned_users: - description: List of mentioned users items: - $ref: '#/components/schemas/UserObject' - title: Mentioned Users + $ref: '#/components/schemas/User' type: array x-stream-index: "042" message_text_updated_at: @@ -6919,77 +7714,46 @@ components: type: number x-stream-index: "051" 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: "005" own_reactions: - description: List of 10 latest reactions of authenticated user to this message items: $ref: '#/components/schemas/Reaction' - title: Own reactions type: array x-stream-index: "013" parent_id: - description: ID of parent message (thread) - title: Parent message ID type: string - x-stream-docs-page-id: threads x-stream-index: "018" 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: "050" pinned: - description: Whether message is pinned or not - title: Pinned type: boolean - x-stream-docs-page-id: pinned_messages x-stream-index: "046" 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: "047" pinned_by: - $ref: '#/components/schemas/UserObject' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages + $ref: '#/components/schemas/User' x-stream-index: "049" poll: $ref: '#/components/schemas/Poll' x-stream-index: "053" poll_id: - description: Identifier of the poll to include in the message - title: Poll ID type: string x-stream-index: "052" quoted_message: $ref: '#/components/schemas/Message' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message x-stream-index: "024" quoted_message_id: - title: ID of quoted message type: string - x-stream-docs-page-id: threads#quote-message x-stream-index: "023" 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: "014" reaction_groups: @@ -7001,70 +7765,38 @@ components: 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: "015" reply_count: - description: Number of replies to this message format: int32 - title: Reply count type: integer x-stream-index: "021" shadowed: - description: Whether the message was shadowed or not - title: Shadowed type: boolean - x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "035" 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: "020" silent: - description: Whether message is silent or not - title: Silent type: boolean x-stream-index: "044" text: - description: Text of the message. Should be empty if `mml` is provided - title: Text type: string x-stream-index: "004" thread_participants: - description: List of users who participate in thread items: - $ref: '#/components/schemas/UserObject' - title: Thread participants + $ref: '#/components/schemas/User' type: array - x-stream-docs-page-id: threads#quote-message x-stream-index: "026" 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: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number x-stream-index: "030" user: - $ref: '#/components/schemas/UserObject' - description: Sender of the message. Required when using server-side API - title: User object + $ref: '#/components/schemas/User' x-stream-index: "010" required: - id @@ -7087,9 +7819,7 @@ components: - mentioned_users - silent - pinned - title: Message type: object - x-stream-docs-page-id: send_message MessageActionRequest: nullable: true properties: @@ -7169,7 +7899,7 @@ components: x-stream-index: "005.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -7177,7 +7907,7 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - hard_delete @@ -7264,7 +7994,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "002.002" type: @@ -7272,7 +8002,7 @@ components: type: string x-stream-index: "005.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004" required: - cid @@ -7294,7 +8024,7 @@ components: ai_moderation_response: $ref: '#/components/schemas/ModerationResponse' description: Response from AI moderation - title: AI moderation response + title: ModerationResponse x-stream-index: "007" blocked_word: description: Word that was blocked @@ -7325,7 +8055,7 @@ components: moderation_thresholds: $ref: '#/components/schemas/Thresholds' description: Thresholds for AI moderation - title: Moderation thresholds + title: Thresholds x-stream-index: "006" updated_at: description: Date/time of the last update @@ -7376,15 +8106,15 @@ components: x-stream-index: "006.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: - default: message.new + default: notification.thread_message_new type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" watcher_count: format: int32 @@ -7408,44 +8138,40 @@ components: properties: channel_id: type: string - x-stream-index: "002.002" + x-stream-index: "003" channel_type: type: string - x-stream-index: "002.003" + x-stream-index: "004" cid: type: string - x-stream-index: "002.001" + x-stream-index: "002" created_at: format: date-time type: number - x-stream-index: "005.002" + x-stream-index: "008" last_read_message_id: type: string - x-stream-index: "006" + x-stream-index: "009" team: type: string - x-stream-index: "004.001" + x-stream-index: "006" thread: $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "003.001" + x-stream-index: "005" type: default: message.read type: string - x-stream-index: "005.001" + x-stream-index: "007" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "001.001" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" required: - cid - channel_id - channel_type - type - created_at - title: MessageReadEvent type: object - x-stream-event-client-type: true - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent MessageRequest: properties: attachments: @@ -7509,20 +8235,31 @@ components: 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 : format + title: Channel CID type: string x-stream-index: "021" 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: "022" custom: @@ -7530,7 +8267,9 @@ components: type: object x-stream-index: "025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: number x-stream-index: "024" deleted_reply_count: @@ -7538,14 +8277,23 @@ components: type: integer x-stream-index: "017" 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: "029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001" image_labels: @@ -7553,16 +8301,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "027" 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: "028" message_text_updated_at: @@ -7570,46 +8324,77 @@ components: type: number x-stream-index: "035" 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" 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: "014" 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: "034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "031" 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: "032" pinned_by: $ref: '#/components/schemas/UserResponse' - x-stream-index: "033" + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "036" quoted_message: $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message x-stream-index: "019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "018" 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: @@ -7621,38 +8406,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "016" shadowed: + description: Whether the message was shadowed or not + title: Shadowed type: boolean + x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "026" 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: "015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "030" 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: "020" 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: "023" 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 @@ -7675,7 +8492,9 @@ components: - mentioned_users - silent - pinned + title: Message type: object + x-stream-docs-page-id: send_message MessageUnblockedEvent: properties: cid: @@ -7690,7 +8509,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "002.002" type: @@ -7698,7 +8517,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - cid @@ -7732,7 +8551,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -7740,7 +8559,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -7785,7 +8604,7 @@ components: x-stream-index: "002.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -7793,7 +8612,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -7807,23 +8626,36 @@ components: 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.021" 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.022" custom: @@ -7831,7 +8663,9 @@ components: type: object x-stream-index: "001.025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: number x-stream-index: "001.024" deleted_reply_count: @@ -7839,14 +8673,23 @@ components: type: integer x-stream-index: "001.017" 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.029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001.001" image_labels: @@ -7854,16 +8697,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "001.027" 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.028" message_text_updated_at: @@ -7871,46 +8720,77 @@ components: type: number x-stream-index: "001.035" 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" 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.014" 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.034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "001.031" 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.032" 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.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "001.036" 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.019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "001.018" 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: @@ -7922,38 +8802,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "001.016" 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.026" 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.015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "001.030" 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.020" 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.023" 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 @@ -7977,7 +8889,9 @@ components: - silent - pinned - channel + title: Message type: object + x-stream-docs-page-id: send_message ModerationActionConfig: nullable: true properties: @@ -8005,257 +8919,66 @@ components: - entity_type - order - action - - icon - - description - - custom - type: object - ModerationConfig: - nullable: true - properties: - async: - type: boolean - x-stream-index: "005" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - x-stream-index: "007" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - x-stream-index: "008" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - x-stream-index: "006" - aws_rekognition_config: - $ref: '#/components/schemas/AWSRekognitionConfig' - x-stream-index: "011" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - x-stream-index: "009" - bodyguard_config: - $ref: '#/components/schemas/BodyguardConfig' - x-stream-index: "010" - created_at: - format: date-time - type: number - x-stream-index: "014" - google_vision_config: - $ref: '#/components/schemas/GoogleVisionConfig' - x-stream-index: "012" - key: - type: string - x-stream-index: "004" - updated_at: - format: date-time - type: number - x-stream-index: "015" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - x-stream-index: "013" - required: - - key - - async - - created_at - - updated_at - 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/UserObject' - x-stream-index: "003.001" - required: - - type - - created_at - title: ModerationCustomActionEvent - type: object - x-stream-event-client-type: true - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - ModerationEvent: - nullable: true - properties: - action: - $ref: '#/components/schemas/ModerationEventActionLog' - x-stream-index: "004" - created_at: - format: date-time - type: number - x-stream-index: "002.003" - flags: - items: - $ref: '#/components/schemas/ModerationEventFlag' - type: array - x-stream-index: "003" - received_at: - format: date-time - type: number - x-stream-index: "002.004" - review_queue_item: - $ref: '#/components/schemas/ModerationEventReviewQueueItem' - x-stream-index: "001" - type: - default: review_queue_item.updated - type: string - x-stream-index: "002.002" - required: - - type - - created_at - type: object - ModerationEventActionLog: - properties: - created_at: - format: date-time - type: number - x-stream-index: "002" - custom: - additionalProperties: {} - type: object - x-stream-index: "006" - id: - type: string - x-stream-index: "001" - reason: - type: string - x-stream-index: "005" - target_user_id: - type: string - x-stream-index: "007" - type: - type: string - x-stream-index: "003" - user_id: - type: string - x-stream-index: "004" - required: - - id - - created_at - - type - - user_id - - reason + - icon + - description - custom - - target_user_id type: object - ModerationEventFlag: - nullable: true + ModerationCustomActionEvent: properties: created_at: format: date-time type: number - x-stream-index: "007" - custom: - additionalProperties: {} - type: object - x-stream-index: "004" - labels: - items: - type: string - type: array - x-stream-index: "005" - reason: - type: string - x-stream-index: "003" - result: - items: - additionalProperties: {} - type: object - type: array - x-stream-index: "006" - type: - type: string + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' x-stream-index: "001" - updated_at: - format: date-time - type: number - x-stream-index: "008" - user_id: - type: string + 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: - - user_id - - result + - type - created_at - - updated_at + title: ModerationCustomActionEvent type: object - ModerationEventReviewQueueItem: + x-stream-event-client-type: true + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ModerationEvent: + nullable: true properties: - assigned_to: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "018" - completed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "010" + action: + $ref: '#/components/schemas/ActionLogResponse' + x-stream-index: "004" created_at: format: date-time type: number - x-stream-index: "002" - entity_creator: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "017" - entity_id: - type: string - x-stream-index: "005" - entity_type: - type: string - x-stream-index: "004" - id: - type: string - x-stream-index: "001" - languages: + x-stream-index: "002.003" + flags: items: - type: string + $ref: '#/components/schemas/Flag2Response' type: array - x-stream-index: "011" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "016" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "007" - recommended_action: - type: string - x-stream-index: "009" - reviewed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "013" - reviewed_by: - type: string - x-stream-index: "014" - severity: - format: int32 - type: integer - x-stream-index: "012" - status: - type: string - x-stream-index: "008" - updated_at: + x-stream-index: "003" + received_at: format: date-time type: number - x-stream-index: "003" + x-stream-index: "002.004" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "001" + type: + default: review_queue_item.updated + type: string + x-stream-index: "002.002" required: - - id + - type - created_at - - updated_at - - entity_type - - entity_id - - status - - recommended_action - - completed_at - - languages - - severity - - reviewed_at - - reviewed_by type: object ModerationFlaggedEvent: properties: @@ -8274,7 +8997,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -8301,7 +9024,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -8418,6 +9141,7 @@ components: x-stream-index: "002" required: - target_ids + title: MuteRequest type: object MuteResponse: nullable: true @@ -8447,6 +9171,7 @@ components: x-stream-index: "002" required: - duration + title: MuteResponse type: object MuteUsersRequest: nullable: true @@ -8476,8 +9201,10 @@ components: 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: @@ -8487,6 +9214,7 @@ components: x-stream-index: "001.001" required: - duration + title: MuteUsersResponse type: object NoiseCancellationSettings: properties: @@ -8672,7 +9400,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -8716,7 +9444,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -8760,7 +9488,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -8820,7 +9548,7 @@ components: type: integer x-stream-index: "008" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -8873,6 +9601,9 @@ components: team: type: string x-stream-index: "002.001" + thread_id: + type: string + x-stream-index: "013" total_unread_count: format: int32 type: integer @@ -8898,7 +9629,7 @@ components: type: integer x-stream-index: "011" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - type @@ -9016,7 +9747,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -9081,9 +9812,11 @@ components: - send-audio - send-video - start-broadcast-call + - start-closed-captions-call - start-record-call - start-transcription-call - stop-broadcast-call + - stop-closed-captions-call - stop-record-call - stop-transcription-call - update-call @@ -9096,17 +9829,17 @@ components: properties: banned: type: boolean - x-stream-index: "014" + x-stream-index: "015" blocked_user_ids: items: type: string type: array - x-stream-index: "042" + x-stream-index: "043" channel_mutes: items: $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "027" + x-stream-index: "028" created_at: format: date-time type: number @@ -9118,48 +9851,52 @@ components: deactivated_at: format: date-time type: number - x-stream-index: "012" + x-stream-index: "013" deleted_at: format: date-time type: number - x-stream-index: "011" + x-stream-index: "012" devices: items: $ref: '#/components/schemas/Device' type: array - x-stream-index: "025" + x-stream-index: "026" id: type: string x-stream-index: "003" invisible: type: boolean - x-stream-index: "021" + x-stream-index: "022" language: type: string - x-stream-index: "032" + x-stream-index: "033" last_active: format: date-time type: number x-stream-index: "010" + last_engaged_at: + format: date-time + type: number + x-stream-index: "011" latest_hidden_channels: items: type: string type: array - x-stream-index: "034" + x-stream-index: "035" mutes: items: $ref: '#/components/schemas/UserMute' type: array - x-stream-index: "026" + x-stream-index: "027" online: type: boolean - x-stream-index: "020" + x-stream-index: "021" privacy_settings: $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" + x-stream-index: "025" push_notifications: $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" + x-stream-index: "024" role: type: string x-stream-index: "004" @@ -9167,23 +9904,23 @@ components: items: type: string type: array - x-stream-index: "033" + x-stream-index: "034" total_unread_count: format: int32 type: integer - x-stream-index: "029" + x-stream-index: "030" unread_channels: format: int32 type: integer - x-stream-index: "030" + x-stream-index: "031" unread_count: format: int32 type: integer - x-stream-index: "028" + x-stream-index: "029" unread_threads: format: int32 type: integer - x-stream-index: "031" + x-stream-index: "032" updated_at: format: date-time type: number @@ -9238,7 +9975,7 @@ components: x-stream-index: "001.010" devices: items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "004" @@ -9403,6 +10140,7 @@ components: 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: @@ -9418,8 +10156,10 @@ components: required: - user_id - session_id + title: PinRequest type: object PinResponse: + description: Basic response information nullable: true properties: duration: @@ -9429,6 +10169,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Poll: properties: @@ -9452,7 +10193,7 @@ components: type: number x-stream-index: "021" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "020" created_by_id: type: string @@ -9693,7 +10434,7 @@ components: additionalProperties: {} type: object writeOnly: true - x-stream-index: "020" + x-stream-index: "021" allow_answers: type: boolean x-stream-index: "008" @@ -9707,13 +10448,13 @@ components: created_at: format: date-time type: number - x-stream-index: "018" + x-stream-index: "019" created_by: $ref: '#/components/schemas/UserResponse' - x-stream-index: "017" + x-stream-index: "018" created_by_id: type: string - x-stream-index: "016" + x-stream-index: "017" description: type: string x-stream-index: "003" @@ -9726,6 +10467,11 @@ components: 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: @@ -9749,11 +10495,11 @@ components: items: $ref: '#/components/schemas/PollVoteResponseData' type: array - x-stream-index: "015" + x-stream-index: "016" updated_at: format: date-time type: number - x-stream-index: "019" + x-stream-index: "020" vote_count: format: int32 type: integer @@ -9780,6 +10526,7 @@ components: - answers_count - vote_counts_by_option - latest_votes_by_option + - latest_answers - own_votes - created_by_id - created_at @@ -9840,7 +10587,7 @@ components: type: number x-stream-index: "011" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "009" user_id: type: string @@ -10189,6 +10936,7 @@ components: - id type: object QueryCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -10210,6 +10958,7 @@ components: required: - members - duration + title: Response type: object QueryCallStatsRequest: nullable: true @@ -10238,6 +10987,7 @@ components: x-stream-index: "002" type: object QueryCallStatsResponse: + description: Basic response information nullable: true properties: duration: @@ -10259,12 +11009,14 @@ components: required: - reports - duration + title: Response type: object QueryCallsRequest: nullable: true properties: filter_conditions: additionalProperties: {} + title: Filters type: object x-stream-index: "003" limit: @@ -10280,14 +11032,18 @@ components: 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 @@ -10312,6 +11068,7 @@ components: required: - calls - duration + title: QueryCallsResponse type: object QueryChannelsRequest: nullable: true @@ -10393,6 +11150,7 @@ components: title: Channels list type: object QueryMembersPayload: + description: Client request properties: filter_conditions: additionalProperties: {} @@ -10431,6 +11189,7 @@ components: required: - type - filter_conditions + title: ClientRequest type: object QueryMessageFlagsPayload: properties: @@ -10456,12 +11215,13 @@ components: x-stream-index: "002" sort: items: - $ref: '#/components/schemas/SortParam' + $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: @@ -10479,6 +11239,7 @@ components: required: - flags - duration + title: QueryMessageFlagsResponse type: object QueryModerationConfigsRequest: nullable: true @@ -10506,11 +11267,12 @@ components: x-stream-index: "002" type: object QueryModerationConfigsResponse: + description: Basic response information nullable: true properties: configs: items: - $ref: '#/components/schemas/ModerationConfig' + $ref: '#/components/schemas/ConfigResponse' type: array x-stream-index: "001" duration: @@ -10527,6 +11289,7 @@ components: required: - configs - duration + title: Response type: object QueryPollVotesRequest: nullable: true @@ -10639,6 +11402,7 @@ components: x-stream-index: "003" type: object QueryReactionsResponse: + description: Basic response information properties: duration: description: Duration of the request in milliseconds @@ -10659,6 +11423,7 @@ components: required: - reactions - duration + title: Response type: object QueryReviewQueueRequest: nullable: true @@ -10672,19 +11437,25 @@ components: maximum: 100 minimum: 0 type: integer - x-stream-index: "006.001" - lock_moderator_duration: + x-stream-index: "007.001" + lock_count: + format: int32 + maximum: 25 + minimum: 1 + type: integer + x-stream-index: "005" + lock_duration: type: integer x-stream-index: "004" - lock_moderator_id: - type: string + lock_items: + type: boolean x-stream-index: "003" next: type: string - x-stream-index: "006.002" + x-stream-index: "007.002" prev: type: string - x-stream-index: "006.003" + x-stream-index: "007.003" sort: items: $ref: '#/components/schemas/SortParamRequest' @@ -10692,9 +11463,10 @@ components: x-stream-index: "002" stats_only: type: boolean - x-stream-index: "005" + x-stream-index: "006" type: object QueryReviewQueueResponse: + description: Basic response information nullable: true properties: action_config: @@ -10711,7 +11483,7 @@ components: x-stream-index: "005.001" items: items: - $ref: '#/components/schemas/ReviewQueueItem' + $ref: '#/components/schemas/ReviewQueueItemResponse' type: array x-stream-index: "001" next: @@ -10731,6 +11503,7 @@ components: - action_config - stats - duration + title: Response type: object QueryThreadsRequest: nullable: true @@ -10852,6 +11625,7 @@ components: - duration type: object RTMPBroadcastRequest: + description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. properties: layout: $ref: '#/components/schemas/LayoutSettingsRequest' @@ -10894,16 +11668,18 @@ components: 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: RTMP Ingress + title: RTMPIngress type: object RTMPSettingsRequest: properties: @@ -10926,29 +11702,31 @@ components: 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: - description: Represents user reaction to a message nullable: true properties: created_at: - description: Date/time of creation format: date-time readOnly: true - title: Created at type: number x-stream-index: "008" custom: @@ -10956,35 +11734,25 @@ components: type: object x-stream-index: "010" message_id: - description: ID of a message user reacted to - title: Message ID type: string x-stream-index: "003" score: - description: Reaction score. If not specified reaction has score of 1 format: int32 - title: Score type: integer x-stream-index: "007" type: - description: The type of reaction (e.g. 'like', 'laugh', 'wow') maxLength: 30 - title: Type type: string x-stream-index: "006" updated_at: - description: Date/time of the last update format: date-time readOnly: true - title: Updated at type: number x-stream-index: "009" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005" user_id: - description: ID of a user who reacted to a message - title: User ID type: string x-stream-index: "004" required: @@ -10994,9 +11762,7 @@ components: - created_at - updated_at - custom - title: Reaction type: object - x-stream-docs-page-id: send_reaction ReactionDeletedEvent: properties: channel_id: @@ -11023,7 +11789,7 @@ components: x-stream-index: "005.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -11031,7 +11797,7 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "004.001" required: - cid @@ -11045,22 +11811,38 @@ components: 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: @@ -11068,6 +11850,7 @@ components: - sum_scores - first_reaction_at - last_reaction_at + title: ReactionGroupResponse type: object ReactionNewEvent: properties: @@ -11095,7 +11878,7 @@ components: x-stream-index: "005.001" thread_participants: items: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: @@ -11103,7 +11886,7 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - cid @@ -11117,6 +11900,7 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent ReactionRemovalResponse: + description: Basic response information nullable: true properties: duration: @@ -11132,11 +11916,15 @@ components: x-stream-index: "002" required: - duration + title: Response type: object 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: @@ -11144,20 +11932,28 @@ components: 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: @@ -11243,42 +12039,21 @@ components: type: string x-stream-index: "006.001" user: - $ref: '#/components/schemas/UserObject' + $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-is-event: true - x-stream-ws-base-event-name: VideoEvent - Read: - nullable: true - 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/UserObject' - x-stream-index: "001" - required: - - last_read - - unread_messages + - channel_id + - channel_type + - type + - created_at + title: ReactionUpdatedEvent type: object + x-stream-event-client-type: true + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent ReadReceipts: properties: enabled: @@ -11326,6 +12101,7 @@ components: - available - disabled - auto-on + title: Mode type: string x-stream-index: "002" quality: @@ -11344,16 +12120,21 @@ components: 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: @@ -11361,6 +12142,7 @@ components: - mode - quality - layout + title: RecordSettingsResponse type: object RejectCallRequest: nullable: true @@ -11370,15 +12152,19 @@ components: 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 RequestPermissionRequest: nullable: true @@ -11391,17 +12177,22 @@ components: 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: @@ -11411,36 +12202,38 @@ components: x-stream-index: "001" required: - duration + title: Response + type: object + RestoreActionRequest: type: object ReviewQueueItem: - nullable: true properties: actions: items: $ref: '#/components/schemas/ActionLog' type: array - x-stream-index: "027" + x-stream-index: "028" assigned_to: - $ref: '#/components/schemas/UserObject' - x-stream-index: "024" + $ref: '#/components/schemas/User' + x-stream-index: "025" bans: items: $ref: '#/components/schemas/Ban' type: array - x-stream-index: "025" + x-stream-index: "026" completed_at: $ref: '#/components/schemas/NullTime' - x-stream-index: "016" + x-stream-index: "017" content_changed: type: boolean - x-stream-index: "028" + x-stream-index: "029" created_at: format: date-time type: number x-stream-index: "004" entity_creator: - $ref: '#/components/schemas/UserObject' - x-stream-index: "023" + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "024" entity_id: type: string x-stream-index: "007" @@ -11449,15 +12242,15 @@ components: x-stream-index: "006" feeds_v2_activity: $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "029" + x-stream-index: "030" feeds_v2_reaction: $ref: '#/components/schemas/Reaction' - x-stream-index: "030" + x-stream-index: "031" flags: items: $ref: '#/components/schemas/Flag2' type: array - x-stream-index: "026" + x-stream-index: "027" has_image: type: boolean x-stream-index: "011" @@ -11474,10 +12267,10 @@ components: items: type: string type: array - x-stream-index: "017" + x-stream-index: "018" message: $ref: '#/components/schemas/Message' - x-stream-index: "022" + x-stream-index: "023" moderation_payload: $ref: '#/components/schemas/ModerationPayload' x-stream-index: "009" @@ -11486,19 +12279,24 @@ components: x-stream-index: "010" recommended_action: type: string - x-stream-index: "015" + x-stream-index: "016" reviewed_at: $ref: '#/components/schemas/NullTime' - x-stream-index: "019" + x-stream-index: "020" reviewed_by: type: string - x-stream-index: "020" + x-stream-index: "021" severity: format: int32 type: integer - x-stream-index: "018" + x-stream-index: "019" status: type: string + x-stream-index: "015" + teams: + items: + type: string + type: array x-stream-index: "014" updated_at: format: date-time @@ -11514,6 +12312,7 @@ components: - has_image - has_video - has_text + - teams - status - recommended_action - completed_at @@ -11526,6 +12325,103 @@ components: - actions - content_changed type: object + ReviewQueueItemResponse: + nullable: true + properties: + actions: + items: + $ref: '#/components/schemas/ActionLogResponse' + type: array + x-stream-index: "020" + assigned_to: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "017" + bans: + items: + $ref: '#/components/schemas/Ban' + type: array + x-stream-index: "018" + completed_at: + format: date-time + type: number + x-stream-index: "009" + created_at: + format: date-time + type: number + x-stream-index: "002" + entity_creator: + $ref: '#/components/schemas/EntityCreatorResponse' + x-stream-index: "015" + entity_creator_id: + type: string + x-stream-index: "016" + entity_id: + type: string + x-stream-index: "005" + entity_type: + type: string + x-stream-index: "004" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "021" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "022" + flags: + items: + $ref: '#/components/schemas/Flag2Response' + type: array + x-stream-index: "019" + id: + type: string + x-stream-index: "001" + languages: + items: + type: string + type: array + x-stream-index: "012" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "014" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "006" + recommended_action: + type: string + x-stream-index: "008" + reviewed_at: + format: date-time + type: number + x-stream-index: "010" + reviewed_by: + type: string + x-stream-index: "011" + severity: + format: int32 + type: integer + x-stream-index: "013" + status: + type: string + x-stream-index: "007" + updated_at: + format: date-time + type: number + x-stream-index: "003" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - status + - recommended_action + - reviewed_by + - languages + - severity + - bans + - flags + - actions + type: object RingSettingsRequest: properties: auto_cancel_timeout_ms: @@ -11816,7 +12712,7 @@ components: $ref: '#/components/schemas/UserResponse' x-stream-index: "001.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: type: string @@ -11982,6 +12878,7 @@ components: - updated_at type: object SendCallEventRequest: + description: Send a call event to the other user nullable: true properties: custom: @@ -11989,15 +12886,19 @@ components: 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 @@ -12070,6 +12971,7 @@ components: - reaction type: object SendReactionResponse: + description: Basic response information nullable: true properties: duration: @@ -12087,11 +12989,13 @@ components: - message - reaction - duration + title: Response type: object ShowChannelRequest: nullable: true type: object ShowChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -12101,12 +13005,14 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object - SortParam: + SortParamRequest: nullable: true properties: direction: - description: Direction of sorting, -1 for descending, 1 for ascending + description: Direction of sorting, 1 for Ascending, -1 for Descending, default + is 1 format: int32 title: Direction type: integer @@ -12117,41 +13023,44 @@ components: type: string x-stream-index: "001" type: object - SortParamRequest: + StartClosedCaptionsRequest: + nullable: true + type: object + StartClosedCaptionsResponse: 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 + duration: type: string - x-stream-index: "001" + x-stream-index: "001.001" + required: + - duration 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: - description: Duration of the request in milliseconds - title: 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: @@ -12165,8 +13074,11 @@ components: 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: @@ -12176,6 +13088,7 @@ components: x-stream-index: "001.001" required: - duration + title: StartRTMPBroadcastsResponse type: object StartRecordingRequest: nullable: true @@ -12183,15 +13096,21 @@ components: 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 @@ -12199,15 +13118,19 @@ components: transcription_external_storage: type: string x-stream-index: "002" + title: StartTranscriptionRequest 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: @@ -12220,6 +13143,7 @@ components: type: object StopAllRTMPBroadcastsRequest: nullable: true + title: StopAllRTMPBroadcastsRequest type: object StopAllRTMPBroadcastsResponse: nullable: true @@ -12231,11 +13155,29 @@ components: x-stream-index: "001.001" required: - duration + title: StopAllRTMPBroadcastsResponse + type: object + StopClosedCaptionsRequest: + nullable: true + 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 StopHLSBroadcastingRequest: nullable: true type: object StopHLSBroadcastingResponse: + description: Basic response information nullable: true properties: duration: @@ -12245,29 +13187,35 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopLiveRequest: nullable: true + 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: - description: Duration of the request in milliseconds - title: 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: @@ -12277,11 +13225,13 @@ components: 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: @@ -12291,11 +13241,13 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopTranscriptionRequest: nullable: true type: object StopTranscriptionResponse: + description: Basic response information nullable: true properties: duration: @@ -12305,6 +13257,71 @@ components: x-stream-index: "001.001" required: - duration + title: Response + type: object + SubmitActionRequest: + nullable: true + properties: + action_type: + enum: + - mark_reviewed + - delete_message + - delete_activity + - delete_reaction + - ban + - custom + - unban + - restore + - delete_user + - unblock + type: string + x-stream-index: "002" + ban: + $ref: '#/components/schemas/BanActionRequest' + x-stream-index: "008" + custom: + $ref: '#/components/schemas/CustomActionRequest' + x-stream-index: "009" + delete_activity: + $ref: '#/components/schemas/DeleteActivityRequest' + x-stream-index: "004" + delete_message: + $ref: '#/components/schemas/DeleteMessageRequest' + x-stream-index: "003" + delete_reaction: + $ref: '#/components/schemas/DeleteReactionRequest' + x-stream-index: "005" + delete_user: + $ref: '#/components/schemas/DeleteUserRequest' + x-stream-index: "006" + item_id: + type: string + x-stream-index: "001" + mark_reviewed: + $ref: '#/components/schemas/MarkReviewedRequest' + x-stream-index: "007" + unban: + $ref: '#/components/schemas/UnbanActionRequest' + x-stream-index: "010" + required: + - item_id + - action_type + type: object + SubmitActionResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + required: + - duration + title: Response type: object Subsession: nullable: true @@ -12329,6 +13346,7 @@ components: - sfu_id type: object SyncRequest: + description: Sync request nullable: true properties: channel_cids: @@ -12349,8 +13367,10 @@ components: required: - channel_cids - last_sync_at + title: SyncRequest type: object SyncResponse: + description: Sync response nullable: true properties: duration: @@ -12375,6 +13395,7 @@ components: required: - events - duration + title: SyncResponse type: object TURNAggregatedStats: properties: @@ -12416,49 +13437,49 @@ components: format: int32 readOnly: true type: integer - x-stream-index: "002" + x-stream-index: "001" channel_cid: type: string - x-stream-index: "003" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "008" + x-stream-index: "007" custom: additionalProperties: {} type: object - x-stream-index: "011" + x-stream-index: "010" last_read_at: format: date-time type: number - x-stream-index: "010" + x-stream-index: "009" last_thread_message_at: format: date-time type: number - x-stream-index: "004" + 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: "009" + x-stream-index: "008" thread_id: description: Thead ID is unique string identifier of the thread title: ID type: string - x-stream-index: "005" + x-stream-index: "004" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: User is the user object title: User - x-stream-index: "007" + x-stream-index: "006" user_id: description: User ID is unique string identifier of the user title: User ID type: string - x-stream-index: "006" + x-stream-index: "005" required: - app_pk - channel_cid @@ -12492,7 +13513,7 @@ components: type: number x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Created By User title: User x-stream-index: "006" @@ -12520,7 +13541,7 @@ components: type: number x-stream-index: "011" parent_message: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' description: Parent Message title: Message x-stream-index: "004" @@ -12569,6 +13590,7 @@ components: - custom type: object ThreadStateResponse: + nullable: true properties: active_participant_count: description: Active Participant Count @@ -12643,7 +13665,7 @@ components: x-stream-index: "001.008" read: items: - $ref: '#/components/schemas/Read' + $ref: '#/components/schemas/ReadStateResponse' type: array x-stream-index: "003" reply_count: @@ -12703,7 +13725,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - cid @@ -12717,16 +13739,24 @@ components: 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: @@ -12769,6 +13799,10 @@ components: TranscriptionSettingsRequest: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -12790,6 +13824,10 @@ components: TranscriptionSettingsResponse: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -12961,7 +13999,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - cid @@ -12997,7 +14035,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - cid @@ -13010,7 +14048,12 @@ components: x-stream-event-client-type: true 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: @@ -13020,8 +14063,10 @@ components: 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: @@ -13031,6 +14076,7 @@ components: x-stream-index: "001.001" required: - duration + title: UnblockUserResponse type: object UnblockUsersRequest: nullable: true @@ -13103,6 +14149,7 @@ components: x-stream-index: "001.003" type: object UnmuteResponse: + description: Basic response information nullable: true properties: duration: @@ -13117,8 +14164,10 @@ components: 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: @@ -13134,8 +14183,10 @@ components: required: - user_id - session_id + title: UnpinRequest type: object UnpinResponse: + description: UnpinResponse is the payload for unpinning a message. nullable: true properties: duration: @@ -13145,6 +14196,7 @@ components: x-stream-index: "001.001" required: - duration + title: UnpinResponse type: object UnreadCountsChannel: properties: @@ -13205,6 +14257,7 @@ components: - parent_message_id type: object UpdateCallMembersRequest: + description: Update call members nullable: true properties: remove_members: @@ -13223,8 +14276,10 @@ components: title: Update Members type: array x-stream-index: "004" + title: UpdateCallMembersRequest type: object UpdateCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -13240,8 +14295,10 @@ components: required: - duration - members + title: Response type: object UpdateCallRequest: + description: Request for updating a call nullable: true properties: custom: @@ -13261,9 +14318,10 @@ components: title: Starts At type: number x-stream-index: "005" + title: UpdateCallRequest type: object UpdateCallResponse: - description: Represents a call + description: Response for updating a call nullable: true properties: call: @@ -13291,7 +14349,7 @@ components: - own_capabilities - blocked_users - duration - title: Call + title: UpdateCallResponse type: object UpdateChannelPartialRequest: nullable: true @@ -13305,6 +14363,7 @@ components: type: string type: array x-stream-index: "002.002" + title: UpdateChannelPartialRequest type: object UpdateChannelPartialResponse: nullable: true @@ -13450,6 +14509,35 @@ components: - members - duration 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: @@ -13516,6 +14604,7 @@ components: - message type: object UpdateMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -13534,6 +14623,7 @@ components: required: - message - duration + title: Response type: object UpdatePollOptionRequest: nullable: true @@ -13727,6 +14817,7 @@ components: - user_id type: object UpdateUserPermissionsResponse: + description: Basic response information nullable: true properties: duration: @@ -13736,6 +14827,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object UpdateUsersPartialRequest: nullable: true @@ -13829,6 +14921,87 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + User: + properties: + ban_expires: + format: date-time + type: number + x-stream-index: "016" + banned: + type: boolean + x-stream-index: "015" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "007" + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "013" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "012" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "022" + language: + type: string + x-stream-index: "033" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "010" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "011" + online: + readOnly: true + type: boolean + x-stream-index: "021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "024" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "040" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "034" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + required: + - id + - role + - custom + - banned + - online + type: object UserBannedEvent: properties: channel_id: @@ -13845,7 +15018,7 @@ components: type: number x-stream-index: "008.002" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" expiration: format: date-time @@ -13865,7 +15038,7 @@ components: type: string x-stream-index: "008.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "007.001" required: - created_by @@ -13887,14 +15060,14 @@ components: type: number x-stream-index: "003.002" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" type: default: user.deactivated type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - created_by @@ -13925,7 +15098,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001.001" required: - type @@ -14036,7 +15209,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -14051,19 +15224,23 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "003" + x-stream-index: "004" + id: + type: string + x-stream-index: "001" image: type: string - x-stream-index: "002" + x-stream-index: "003" name: type: string - x-stream-index: "001" + x-stream-index: "002" roles: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" required: + - id - name - image - custom @@ -14085,7 +15262,7 @@ components: type: number x-stream-index: "008" target: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: User who's muted title: Target x-stream-index: "007" @@ -14096,7 +15273,7 @@ components: type: number x-stream-index: "010" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: Owner of channel mute title: User x-stream-index: "005" @@ -14148,7 +15325,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -14158,110 +15335,6 @@ components: x-stream-event-client-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - UserObject: - description: Represents chat user - properties: - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: number - x-stream-index: "015" - banned: - description: Whether a user is banned or not - title: Banned - type: boolean - x-stream-index: "014" - created_at: - description: Date/time of creation - format: date-time - readOnly: true - title: Created at - type: number - x-stream-index: "007" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - deactivated_at: - description: Date of deactivation - format: date-time - readOnly: true - title: Deactivated at - type: number - x-stream-index: "012" - deleted_at: - description: Date/time of deletion - format: date-time - readOnly: true - title: Deleted at - type: number - x-stream-index: "011" - id: - description: Unique user identifier - title: ID - type: string - x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "021" - language: - description: Preferred language of a user - title: Language - type: string - x-stream-index: "032" - last_active: - description: Date of last activity - format: date-time - readOnly: true - title: Last active - type: number - x-stream-index: "010" - online: - description: Whether a user online or not - readOnly: true - title: Online - type: boolean - x-stream-index: "020" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" - push_notifications: - $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" - revoke_tokens_issued_before: - description: Revocation date for tokens - format: date-time - title: Revoke tokens issued before - type: number - x-stream-index: "039" - role: - description: Determines the set of user permissions - title: Role - type: string - x-stream-index: "004" - teams: - description: List of teams user is a part of - items: - type: string - title: Teams - type: array - x-stream-index: "033" - updated_at: - description: Date/time of the last update - format: date-time - readOnly: true - title: Updated at - type: number - x-stream-index: "008" - required: - - id - - role - - custom - - banned - - online - title: User object - type: object UserPresenceChangedEvent: properties: created_at: @@ -14273,7 +15346,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001.001" required: - type @@ -14294,7 +15367,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -14305,6 +15378,7 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent UserRequest: + description: User request object properties: custom: additionalProperties: {} @@ -14332,15 +15406,17 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' x-stream-index: "010" required: - id + title: UserRequest type: object UserResponse: + description: User response object properties: banned: description: Whether a user is banned or not @@ -14444,6 +15520,7 @@ components: - shadow_banned - devices - invisible + title: UserResponse type: object UserSessionStats: properties: @@ -14689,7 +15766,7 @@ components: type: string x-stream-index: "005.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - shadow @@ -14722,7 +15799,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -14748,7 +15825,7 @@ components: type: string x-stream-index: "001.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002" required: - type @@ -14805,7 +15882,7 @@ components: type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005.001" watcher_count: format: int32 @@ -14843,7 +15920,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" watcher_count: format: int32 @@ -14863,21 +15940,28 @@ components: x-stream-ws-base-event-name: VideoEvent VelocityFilterConfig: properties: + async: + type: boolean + x-stream-index: "001" cascading_actions: type: boolean - x-stream-index: "003" + x-stream-index: "004" enabled: type: boolean - x-stream-index: "001" + x-stream-index: "002" + first_message_only: + type: boolean + x-stream-index: "005" rules: items: $ref: '#/components/schemas/VelocityFilterConfigRule' type: array - x-stream-index: "002" + x-stream-index: "003" required: - enabled - rules - cascading_actions + - first_message_only type: object VelocityFilterConfigRule: properties: @@ -14889,6 +15973,10 @@ components: - ban type: string x-stream-index: "001" + ban_duration: + format: int32 + type: integer + x-stream-index: "002" cascading_action: enum: - flag @@ -14901,33 +15989,49 @@ components: 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" shadow_ban: type: boolean x-stream-index: "003" - timeout: - format: date-time - type: number - x-stream-index: "002" + 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" 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 type: object - VideoQuality: - properties: - resolution: - $ref: '#/components/schemas/VideoResolution' - x-stream-index: "002" - usage_type: - type: string - x-stream-index: "001" - type: object - VideoResolution: + VideoDimension: properties: height: type: integer @@ -14939,6 +16043,15 @@ components: - width - height type: object + VideoQuality: + properties: + resolution: + $ref: '#/components/schemas/VideoDimension' + x-stream-index: "002" + usage_type: + type: string + x-stream-index: "001" + type: object VideoSettingsRequest: properties: access_request_enabled: @@ -14992,7 +16105,7 @@ components: VoteData: properties: Option: - $ref: '#/components/schemas/PollOption' + $ref: '#/components/schemas/PollOptionResponseData' x-stream-index: "003" answer_text: type: string @@ -15003,6 +16116,7 @@ components: x-stream-index: "001" type: object WSAuthMessage: + description: Websocket auth message nullable: true properties: products: @@ -15020,6 +16134,7 @@ components: required: - user_details - token + title: WSAuthMessage type: object WSChannelEvent: description: The discriminator object for all websocket channel events, it maps @@ -15060,6 +16175,9 @@ components: 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' @@ -15153,6 +16271,9 @@ components: - $ref: '#/components/schemas/AnyEvent' - $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' @@ -15251,6 +16372,9 @@ components: 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' @@ -15337,6 +16461,9 @@ components: - $ref: '#/components/schemas/AnyEvent' - $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' @@ -15420,6 +16547,7 @@ components: - $ref: '#/components/schemas/UserUnreadReminderEvent' - $ref: '#/components/schemas/UserUpdatedEvent' WrappedUnreadCountsResponse: + description: Basic response information nullable: true properties: channel_type: @@ -15457,6 +16585,7 @@ components: - channel_type - threads - duration + title: Response type: object securitySchemes: JWT: @@ -15499,7 +16628,7 @@ components: type: apiKey info: title: Stream API - version: v133.1.0 + version: v137.0.0 openapi: 3.0.3 paths: /api/v2/app: @@ -15513,7 +16642,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetApplicationResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15616,7 +16745,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15668,6 +16797,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest required: true responses: "200": @@ -15793,7 +16923,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EventResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15850,7 +16980,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -15954,7 +17084,7 @@ paths: application/json: schema: $ref: '#/components/schemas/HideChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16011,7 +17141,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16077,6 +17207,61 @@ paths: summary: Upload image tags: - product:chat + /api/v2/chat/channels/{type}/{id}/member/{user_id}: + patch: + description: |2+ + + operationId: UpdateMemberPartial + parameters: + - in: path + name: user_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - 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: | @@ -16360,7 +17545,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShowChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16416,7 +17601,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16522,7 +17707,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16754,7 +17939,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16793,7 +17978,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16844,7 +18029,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16942,7 +18127,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16993,7 +18178,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendReactionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17053,7 +18238,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactionRemovalResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17154,7 +18339,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryReactionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17202,7 +18387,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17438,7 +18623,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetRepliesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17478,7 +18663,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: Successful response + description: QueryMessageFlagsResponse "400": content: application/json: @@ -17556,7 +18741,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17681,7 +18866,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -17927,7 +19112,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -18199,6 +19384,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SyncRequest' + description: SyncRequest required: true responses: "201": @@ -18206,7 +19392,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SyncResponse' - description: Successful response + description: SyncResponse "400": content: application/json: @@ -18406,7 +19592,7 @@ paths: application/json: schema: $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18443,7 +19629,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -18469,7 +19655,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListDevicesResponse' - description: Successful response + description: ListDevicesResponse "400": content: application/json: @@ -18494,6 +19680,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": @@ -18501,7 +19688,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -18606,7 +19793,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BanResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18639,7 +19826,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryModerationConfigsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18672,7 +19859,7 @@ paths: application/json: schema: $ref: '#/components/schemas/FlagResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18698,6 +19885,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteRequest' + description: MuteRequest required: true responses: "201": @@ -18705,7 +19893,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteResponse' - description: Successful response + description: MuteResponse "400": content: application/json: @@ -18738,7 +19926,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryReviewQueueResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18754,6 +19942,39 @@ paths: summary: Query review queue items tags: - product:moderation + /api/v2/moderation/submit_action: + post: + description: | + Moderation v2 submit action + 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: Response + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Bad request + "429": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Too many requests + summary: Moderation v2 submit action + tags: + - product:moderation /api/v2/og: get: description: | @@ -19060,7 +20281,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallResponse' - description: Successful response + description: GetCallResponse "400": content: application/json: @@ -19112,6 +20333,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallRequest' + description: UpdateCallRequest required: true responses: "200": @@ -19119,7 +20341,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallResponse' - description: Call + description: UpdateCallResponse "400": content: application/json: @@ -19181,6 +20403,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallRequest' + description: GetOrCreateCallRequest required: true responses: "201": @@ -19188,7 +20411,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallResponse' - description: Successful response + description: GetOrCreateCallResponse "400": content: application/json: @@ -19255,7 +20478,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteRecordingResponse' - description: Successful response + description: DeleteRecordingResponse "400": content: application/json: @@ -19322,7 +20545,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteTranscriptionResponse' - description: Successful response + description: DeleteTranscriptionResponse "400": content: application/json: @@ -19376,7 +20599,7 @@ paths: application/json: schema: $ref: '#/components/schemas/AcceptCallResponse' - description: Successful response + description: AcceptCallResponse "400": content: application/json: @@ -19429,6 +20652,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserRequest' + description: BlockUserRequest required: true responses: "201": @@ -19436,7 +20660,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserResponse' - description: Successful response + description: BlockUserResponse "400": content: application/json: @@ -19489,6 +20713,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallRequest' + description: DeleteCallRequest required: true responses: "201": @@ -19496,7 +20721,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallResponse' - description: Successful response + description: DeleteCallResponse "400": content: application/json: @@ -19547,6 +20772,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventRequest' + description: SendCallEventRequest required: true responses: "201": @@ -19554,7 +20780,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventResponse' - description: Successful response + description: SendCallEventResponse "400": content: application/json: @@ -19615,7 +20841,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CollectUserFeedbackResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19668,6 +20894,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveRequest' + description: GoLiveRequest required: true responses: "201": @@ -19675,7 +20902,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19733,6 +20960,7 @@ paths: application/json: schema: $ref: '#/components/schemas/JoinCallRequest' + description: JoinCallRequest required: true responses: "201": @@ -19740,7 +20968,7 @@ paths: application/json: schema: $ref: '#/components/schemas/JoinCallResponse' - description: Successful response + description: JoinCallResponse "400": content: application/json: @@ -19794,7 +21022,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EndCallResponse' - description: Successful response + description: EndCallResponse "400": content: application/json: @@ -19851,6 +21079,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersRequest' + description: UpdateCallMembersRequest required: true responses: "201": @@ -19858,7 +21087,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19908,6 +21137,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersRequest' + description: MuteUsersRequest required: true responses: "201": @@ -19915,7 +21145,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersResponse' - description: Successful response + description: MuteUsersResponse "400": content: application/json: @@ -19961,6 +21191,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinRequest' + description: PinRequest required: true responses: "201": @@ -19968,7 +21199,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20024,7 +21255,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendReactionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20071,7 +21302,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListRecordingsResponse' - description: Successful response + description: ListRecordingsResponse "400": content: application/json: @@ -20124,6 +21355,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RejectCallRequest' + description: RejectCallRequest required: true responses: "201": @@ -20131,7 +21363,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RejectCallResponse' - description: Successful response + description: RejectCallResponse "400": content: application/json: @@ -20181,6 +21413,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RequestPermissionRequest' + description: RequestPermissionRequest required: true responses: "201": @@ -20188,7 +21421,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RequestPermissionResponse' - description: Successful response + description: RequestPermissionResponse "400": content: application/json: @@ -20238,6 +21471,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsRequest' + description: StartRTMPBroadcastsRequest required: true responses: "201": @@ -20245,7 +21479,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsResponse' - description: Successful response + description: StartRTMPBroadcastsResponse "400": content: application/json: @@ -20302,6 +21536,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsRequest' + description: StopRTMPBroadcastsRequest required: true responses: "201": @@ -20309,7 +21544,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20360,7 +21595,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopAllRTMPBroadcastsResponse' - description: Successful response + description: StopAllRTMPBroadcastsResponse "400": content: application/json: @@ -20411,7 +21646,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartHLSBroadcastingResponse' - description: Successful response + description: StartHLSBroadcastingResponse "400": content: application/json: @@ -20427,6 +21662,57 @@ paths: summary: Start HLS broadcasting tags: - product:video + /api/v2/video/call/{type}/{id}/start_closed_captions: + post: + description: | + Starts closed captions + + Required permissions: + - StartClosedCaptions + 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" + 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_recording: post: description: | @@ -20464,6 +21750,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingRequest' + description: StartRecordingRequest required: true responses: "201": @@ -20471,7 +21758,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingResponse' - description: Successful response + description: StartRecordingResponse "400": content: application/json: @@ -20521,6 +21808,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionRequest' + description: StartTranscriptionRequest required: true responses: "201": @@ -20528,7 +21816,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionResponse' - description: Successful response + description: StartTranscriptionResponse "400": content: application/json: @@ -20583,7 +21871,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20630,7 +21918,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopHLSBroadcastingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20646,6 +21934,56 @@ paths: summary: Stop HLS broadcasting tags: - product:video + /api/v2/video/call/{type}/{id}/stop_closed_captions: + post: + description: | + Stops closed captions + + Sends events: + - call.transcription_stopped + + Required permissions: + - StopClosedCaptions + 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" + 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_live: post: description: |2 @@ -20684,7 +22022,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopLiveResponse' - description: Successful response + description: StopLiveResponse "400": content: application/json: @@ -20734,7 +22072,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRecordingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20784,7 +22122,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopTranscriptionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20813,7 +22151,9 @@ paths: name: type required: true schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true x-stream-index: "001.001" @@ -20821,7 +22161,9 @@ paths: name: id required: true schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true x-stream-index: "001.002" @@ -20831,7 +22173,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListTranscriptionsResponse' - description: Successful response + description: ListTranscriptionsResponse "400": content: application/json: @@ -20882,6 +22224,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserRequest' + description: UnblockUserRequest required: true responses: "201": @@ -20889,7 +22232,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserResponse' - description: Successful response + description: UnblockUserResponse "400": content: application/json: @@ -20935,6 +22278,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinRequest' + description: UnpinRequest required: true responses: "201": @@ -20942,7 +22286,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinResponse' - description: Successful response + description: UnpinResponse "400": content: application/json: @@ -20998,7 +22342,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateUserPermissionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21034,7 +22378,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21070,7 +22414,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21106,6 +22450,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsRequest' + description: QueryCallsRequest required: true responses: "201": @@ -21113,7 +22458,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsResponse' - description: Successful response + description: QueryCallsResponse "400": content: application/json: @@ -21140,7 +22485,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetEdgesResponse' - description: Successful response + description: Response "400": content: application/json: diff --git a/openapi/serverside-api.json b/openapi/serverside-api.json index 503d1b4d..34bfb998 100644 --- a/openapi/serverside-api.json +++ b/openapi/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","notification_template"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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/UserObject","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"005"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["id","created_at","type","reason","custom"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"type":"object"},"AppResponseFields":{"properties":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"039"},"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":"042"},"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"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"041"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"040"},"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_enabled":{"type":"boolean","x-stream-index":"043"},"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"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"video_provider":{"type":"string","x-stream-index":"038"},"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"],"type":"object"},"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":{"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"002"}},"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":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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/UserObject","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/UserObject","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"004"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"type":"array","x-stream-index":"002"}},"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"},"BlockListResponse":{"description":"Block list contains restricted words","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"003"},"type":{"description":"Block list type.","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":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"005"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","action"],"type":"object"},"BlockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"BlockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"BodyguardConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"profile":{"type":"string","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"003"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"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"},"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":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"type":"object"},"CallEvent":{"nullable":true,"properties":{"additional":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal"],"type":"object"},"CallIngressResponse":{"properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","x-stream-index":"001"}},"required":["rtmp"],"title":"Call inputs","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"},"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"},"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"],"type":"object"},"CallRequest":{"properties":{"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"}},"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"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":"020"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"013"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"018"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"022"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"019"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"016"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"014"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"021"},"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","backstage","settings","blocked_user_ids","ingress","egress"],"title":"Call","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":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"007"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"009"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"008"},"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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"type":"object"},"CallStateResponseFields":{"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"],"type":"object"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"CallTypeResponse":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"external_storage":{"type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"truncated_by":{"$ref":"#/components/schemas/UserObject","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":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.025"},"blocklist":{"type":"string","x-stream-index":"001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.023"},"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.018"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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"},"title":"Grants","type":"object","x-stream-index":"002","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands"],"type":"object"},"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"},"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"},"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":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"017"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"016"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"021"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","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":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"009"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"010"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"008"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"022"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"title":"User ID","type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"properties":{"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":"016"},"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":"017"},"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":"015"},"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","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/UserObject","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"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":"021"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"022"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"027"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"Config","x-stream-index":"017"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"024"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/UserObject","description":"Creator of the channel","title":"Created by","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"012"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"026"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"023"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"003"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"006"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"015"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"014"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"019"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"018"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"type":"string"},"title":"Own Capabilities","type":"array","x-stream-index":"025"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"020"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"Truncated At","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"029"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"commands":{"description":"List of commands that channel supports","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands"],"type":"object"},"CheckExternalStorageResponse":{"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"],"type":"object"},"CheckPushRequest":{"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"},"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":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"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":"007.001"},"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":"004"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"005"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"006"},"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":{"type":"string","x-stream-index":"005"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"test_mode":{"type":"boolean","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"004"},"recommended_action":{"type":"string","x-stream-index":"003"},"status":{"type":"string","x-stream-index":"001"},"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"},"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":["user_session_id","sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["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"},"Config":{"properties":{"app_certificate":{"type":"string","x-stream-index":"002"},"app_id":{"type":"string","x-stream-index":"001"},"default_role":{"enum":["attendee","publisher","subscriber","admin"],"type":"string","x-stream-index":"003"},"role_map":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["app_id","app_certificate"],"type":"object"},"ConfigResponse":{"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key","async","created_at","updated_at"],"type":"object"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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"},"type":{"description":"Block list type.","enum":["regex","domain","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"},"CreateCallTypeRequest":{"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"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"required":["name"],"type":"object"},"CreateCallTypeResponse":{"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"],"type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Enables automatic message moderation","enum":["disabled","simple","AI"],"title":"Auto moderation","type":"string","x-stream-index":"017"},"automod_behavior":{"description":"Sets behavior of automatic moderation","enum":["flag","block"],"title":"Auto moderation behavior","type":"string","x-stream-index":"018"},"blocklist":{"description":"Name of the blocklist to use","title":"Blocklist","type":"string","x-stream-index":"022"},"blocklist_behavior":{"description":"Sets behavior of blocklist","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"023"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"024"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"019"},"connect_events":{"description":"Connect events support","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Enables custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"021"},"mark_messages_pending":{"description":"Marks messages as pending by default","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Number of maximum message characters","format":"int32","title":"Maximum message length","type":"integer","x-stream-index":"016"},"message_retention":{"type":"string","x-stream-index":"015"},"mutes":{"description":"Enables mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"format":"int32","minimum":10,"type":"integer","x-stream-index":"025"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"026"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"020"},"polls":{"description":"Enables polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Enables push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Enables message reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events support","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Enables message replies (threads)","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Enables message search","title":"Search","type":"boolean","x-stream-index":"007"},"typing_events":{"description":"Typing events support","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Enables file uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"Enables URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"}},"required":["name","max_message_length","automod","automod_behavior"],"type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.025"},"blocklist":{"type":"string","x-stream-index":"001.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Represents custom chat 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":"Command","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","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"},"CreateDeviceRequest":{"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"],"type":"object"},"CreateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"type":"object"},"CreateExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"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"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"position":{"format":"int32","type":"integer","x-stream-index":"003"},"text":{"description":"Option text","title":"string","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"}},"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":{"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"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"name":{"type":"string","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"007"},"recommended_action":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"008.001"},"id":{"type":"string","x-stream-index":"001"},"moderator_action":{"type":"string","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"002"},"report":{"additionalProperties":{},"type":"array","x-stream-index":"004"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"007"},"scored_at":{"format":"date-time","type":"number","x-stream-index":"005"},"status":{"type":"string","x-stream-index":"003"}},"required":["id","recommended_action","status","report","scored_at","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":{"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"],"type":"object"},"DeactivateUsersResponse":{"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"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteCallRequest":{"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"}},"type":"object"},"DeleteCallResponse":{"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":"003.001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["call","duration"],"type":"object"},"DeleteChannelResponse":{"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"],"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":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","duration"],"type":"object"},"DeleteExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"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"],"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"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"},"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.006"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.005"},"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":{"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":"Device","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"},"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"}},"required":["playlist_url"],"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"},"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":{"nullable":true,"type":"object"},"EndCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"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"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled","apns"],"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":{"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"],"type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":25,"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"},"ExportChannelsResult":{"properties":{"path":{"description":"S3 path of result","title":"PathPrefix","type":"string","x-stream-index":"002"},"s3_bucket_name":{"description":"S3 bucket name result","title":"S3 bucket name","type":"string","x-stream-index":"003"},"url":{"description":"URL of result","title":"URL","type":"string","x-stream-index":"001"}},"required":["url"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"},"reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","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":{"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"],"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"},"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":"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","notification_template","data_template","apn_template"],"type":"object"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"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","reason"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item_id":{"type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"type":"object"},"GetApplicationResponse":{"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"],"type":"object"},"GetBlockListResponse":{"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":"Get Block list response","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"},"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"],"type":"object"},"GetCallStatsResponse":{"nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"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"],"type":"object"},"GetChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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":{"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands","duration"],"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"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"GetCustomPermissionResponse":{"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"],"type":"object"},"GetEdgesResponse":{"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"],"type":"object"},"GetExportChannelsStatusResponse":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.007.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Contains task error in case of failure","title":"Error","x-stream-index":"003"},"result":{"$ref":"#/components/schemas/ExportChannelsResult","description":"Contains task result in case of success","title":"ExportChannelsResult","x-stream-index":"002"},"status":{"description":"Task status","enum":["waiting","pending","running","completed","failed","canceled"],"title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"type":"object"},"GetImportResponse":{"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"],"type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/Message"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"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"],"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"}},"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"],"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":{"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"],"type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"history":{"items":{"$ref":"#/components/schemas/ReviewQueueItem"},"type":"array","x-stream-index":"002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["history","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"},"GetUserModerationReportResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_blocks":{"items":{"$ref":"#/components/schemas/UserBlock"},"type":"array","x-stream-index":"003"},"user_mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"002"}},"required":["user","user_mutes","user_blocks","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"type":"object"},"GoLiveResponse":{"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"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"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"],"type":"object"},"HLSSettingsResponse":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":"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"},"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":{"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":{"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":{"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"ListBlockListResponse":{"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"],"type":"object"},"ListCallTypeResponse":{"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"],"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"],"type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"type":"object"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"type":"object"},"ListExternalStorageResponse":{"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"],"type":"object"},"ListImportsResponse":{"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"],"type":"object"},"ListPermissionsResponse":{"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"],"type":"object"},"ListPushProvidersResponse":{"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"],"type":"object"},"ListRecordingsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"type":"object"},"ListRolesResponse":{"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"],"type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"items":{"$ref":"#/components/schemas/CallTranscription"},"type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"type":"object"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"type":"object"},"MemberRequest":{"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"],"type":"object"},"MemberResponse":{"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"],"type":"object"},"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":{"description":"Represents any chat message","nullable":true,"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":"011"},"before_message_send_failed":{"description":"Whether `before_message_send webhook` failed or not. Field is only accessible in push webhook","title":"Before Message Send Failed","type":"boolean","x-stream-docs-page-id":"before_message_send_webhook","x-stream-index":"045"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"027"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"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":"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":"043"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","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":"039"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Latest reactions","type":"array","x-stream-index":"012"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserObject"},"title":"Mentioned Users","type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"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":"005"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Own reactions","type":"array","x-stream-index":"013"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"018"},"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":"050"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"046"},"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":"047"},"pinned_by":{"$ref":"#/components/schemas/UserObject","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"024"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"023"},"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":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"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":"015"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"021"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"035"},"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":"020"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"044"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"004"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserObject"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"026"},"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":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/UserObject","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"010"}},"required":["id","text","html","type","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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"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"},"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"},"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":"AI moderation response","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":"Moderation 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"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"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"},"last_read_message_id":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"004.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"001.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"MessageReadEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"020.002"},"user_id":{"type":"string","x-stream-index":"020.001"}},"type":"object"},"MessageResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"008"},"cid":{"type":"string","x-stream-index":"021"},"command":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"html":{"type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"029"},"id":{"type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"027"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"mml":{"type":"string","x-stream-index":"003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"010"},"parent_id":{"type":"string","x-stream-index":"014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"034"},"pinned":{"type":"boolean","x-stream-index":"031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"037"},"poll_id":{"type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"019"},"quoted_message_id":{"type":"string","x-stream-index":"018"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"016"},"shadowed":{"type":"boolean","x-stream-index":"026"},"show_in_channel":{"type":"boolean","x-stream-index":"015"},"silent":{"type":"boolean","x-stream-index":"030"},"text":{"type":"string","x-stream-index":"002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"020"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"023"},"user":{"$ref":"#/components/schemas/UserResponse","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"],"type":"object"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageWithChannelResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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","channel"],"type":"object"},"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"},"ModerationConfig":{"nullable":true,"properties":{"async":{"type":"boolean","x-stream-index":"005"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"007"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"008"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"006"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"011"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"009"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"010"},"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"012"},"key":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"013"}},"required":["key","async","created_at","updated_at"],"type":"object"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"ModerationUsageStats":{"nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"003"},"metric":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"value":{"format":"int32","type":"integer","x-stream-index":"007"}},"required":["bucket","updated_at","metric","value"],"type":"object"},"ModeratorStats":{"nullable":true,"properties":{"action_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"items_reviewed":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["id","items_reviewed","action_counts"],"type":"object"},"ModeratorStatsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"moderator_stats":{"items":{"$ref":"#/components/schemas/ModeratorStats"},"type":"array","x-stream-index":"001"}},"required":["moderator_stats","duration"],"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"],"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"],"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"}},"type":"object"},"MuteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"014"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"042"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"027"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"025"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"type":"string","x-stream-index":"032"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"026"},"online":{"type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"033"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"028"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"031"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"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"},"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"},"PinRequest":{"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"],"type":"object"},"PinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"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/UserObject","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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"020"},"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":"018"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"created_by_id":{"type":"string","x-stream-index":"016"},"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_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":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"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","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/UserObject","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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2"],"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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"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"},"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"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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":{"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"],"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":{"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"],"type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"004"}},"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"],"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"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"templates":{"items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryMembersPayload":{"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"],"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/SortParam"},"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":{"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"],"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":{},"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/SortParamRequest"},"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":{"items":{"$ref":"#/components/schemas/ModerationConfig"},"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"},"QueryModerationLogsRequest":{"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/SortParamRequest"},"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":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"logs":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"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":{"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"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"lock_moderator_duration":{"type":"integer","x-stream-index":"004"},"lock_moderator_id":{"type":"string","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"stats_only":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItem"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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"},"QueryUsageStatsRequest":{"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/SortParamRequest"},"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"},"QueryUsageStatsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"items":{"items":{"$ref":"#/components/schemas/ModerationUsageStats"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["items","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"},"QueueStatsResponse":{"nullable":true,"properties":{"avg_time_to_action":{"type":"integer","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"time_to_action_buckets":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"}},"required":["avg_time_to_action","time_to_action_buckets","duration"],"type":"object"},"RTMPBroadcastRequest":{"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"],"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMP Ingress","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"}},"type":"object"},"RTMPSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"type":"object"},"Reaction":{"description":"Represents user reaction to a message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"description":"ID of a message user reacted to","title":"Message ID","type":"string","x-stream-index":"003"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"007"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"description":"ID of a user who reacted to a message","title":"User ID","type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"number","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"number","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"type":"object"},"ReactionRemovalResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"type":"object"},"ReactionRequest":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"format":"int32","type":"integer","x-stream-index":"002"},"type":{"maxLength":30,"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","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"],"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":{"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"],"type":"object"},"ReactivateUsersResponse":{"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"],"type":"object"},"Read":{"nullable":true,"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/UserObject","x-stream-index":"001"}},"required":["last_read","unread_messages"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"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":["audio_only","mode","quality"],"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"],"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"],"type":"object"},"RecordSettingsResponse":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"type":"object"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"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":"027"},"assigned_to":{"$ref":"#/components/schemas/UserObject","x-stream-index":"024"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"025"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"016"},"content_changed":{"type":"boolean","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/UserObject","x-stream-index":"023"},"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":"029"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"030"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"022"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"015"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"019"},"reviewed_by":{"type":"string","x-stream-index":"020"},"severity":{"format":"int32","type":"integer","x-stream-index":"018"},"status":{"type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"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":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"S3Request":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"type":"object"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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":{"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"}},"type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, -1 for descending, 1 for ascending","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"},"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"},"StartHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StartHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"playlist_url":{"type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"type":"object"},"StartRTMPBroadcastsRequest":{"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"],"type":"object"},"StartRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"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"],"type":"object"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopLiveRequest":{"nullable":true,"type":"object"},"StopLiveResponse":{"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"],"type":"object"},"StopRTMPBroadcastsRequest":{"nullable":true,"type":"object"},"StopRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopTranscriptionRequest":{"nullable":true,"type":"object"},"StopTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock"],"type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","x-stream-index":"007"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","x-stream-index":"008"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","x-stream-index":"006"},"item_id":{"type":"string","x-stream-index":"001"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["duration"],"type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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":"002"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"011"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"010"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"004"},"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":"009"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","description":"User is the user object","title":"User","x-stream-index":"007"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"006"}},"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/UserObject","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/Message","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":{"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"},"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/Read"},"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"},"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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"title":"string","type":"string","x-stream-index":"002"},"languages":{"description":"the languages to transcribe to","items":{"type":"string"},"maximum":2,"title":"array","type":"array","x-stream-index":"003"},"mode":{"description":"oneof=available disabled auto-on","enum":["available","disabled","auto-on"],"title":"string","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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"}},"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005"},"unbanned_by_id":{"type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"UnblockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"],"type":"object"},"UnmuteResponse":{"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"],"type":"object"},"UnpinRequest":{"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"],"type":"object"},"UnpinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"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":"004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"003"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"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":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.040"},"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.042"},"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.043"},"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"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.045"},"feeds_v2_region":{"type":"string","x-stream-index":"001.044"},"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"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.041"},"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_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_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"video_provider":{"enum":["agora","hms"],"type":"string","x-stream-index":"001.039"},"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":{"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateCallMembersRequest":{"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"}},"type":"object"},"UpdateCallMembersResponse":{"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"],"type":"object"},"UpdateCallRequest":{"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"}},"type":"object"},"UpdateCallResponse":{"description":"Represents 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":"Call","type":"object"},"UpdateCallTypeRequest":{"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"}},"type":"object"},"UpdateCallTypeResponse":{"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"],"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.025"},"blocklist":{"type":"string","x-stream-index":"009.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.023"},"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.018"},"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"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.025"},"blocklist":{"type":"string","x-stream-index":"003.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"description":"Represents custom chat 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"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"Command","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"type":"object"},"UpdateExternalStorageResponse":{"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"],"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":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"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"],"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"},"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","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":{"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"],"type":"object"},"UserBlock":{"nullable":true,"properties":{"blocked_by_user_id":{"type":"string","x-stream-index":"005"},"blocked_user_id":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"image":{"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"004"}},"required":["name","image","custom","roles"],"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/UserObject","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/UserObject","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"},"UserObject":{"description":"Represents chat user","properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"015"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"014"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","readOnly":true,"title":"Deactivated at","type":"number","x-stream-index":"012"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","readOnly":true,"title":"Deleted at","type":"number","x-stream-index":"011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"032"},"last_active":{"description":"Date of last activity","format":"date-time","readOnly":true,"title":"Last active","type":"number","x-stream-index":"010"},"online":{"description":"Whether a user online or not","readOnly":true,"title":"Online","type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"039"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"004"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"033"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"title":"User object","type":"object"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"type":"object"},"VelocityFilterConfig":{"properties":{"cascading_actions":{"type":"boolean","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"002"}},"required":["enabled","rules","cascading_actions"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"timeout":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["action","shadow_ban","ip_ban","cascading_threshold","cascading_action"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoResolution","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"VideoResolution":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"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":{"Option":{"$ref":"#/components/schemas/PollOption","x-stream-index":"003"},"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":"022"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"023"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"010"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_type":{"type":"string","x-stream-index":"006"},"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":"027"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"021"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"018"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"013"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"007"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"008"},"parent_id":{"type":"string","x-stream-index":"024"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"014"},"poll_vote":{"$ref":"#/components/schemas/PollVote","x-stream-index":"015"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"009"},"reason":{"type":"string","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"025"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"012"},"thread_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"016"},"user_id":{"type":"string","x-stream-index":"017"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"019"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WrappedUnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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"],"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":"v133.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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"description":"Successful response"},"400":{"content":{"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/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"Get Block list response"},"400":{"content":{"application/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/Response"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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"}}},"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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteAttachment\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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":"Successful response"},"400":{"content":{"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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"}}},"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Command","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Command","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"Successful response"},"400":{"content":{"application/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/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/export_channels/{id}":{"get":{"description":"\n","operationId":"GetExportChannelsStatus","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/GetExportChannelsStatusResponse"}}},"description":"Successful response"},"400":{"content":{"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 status","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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":"Successful response"},"400":{"content":{"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","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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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":"Successful response"},"400":{"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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"description":"Successful response"},"400":{"content":{"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","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"description":"Successful response"},"400":{"content":{"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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadMessageFlags\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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":"Successful response"},"400":{"content":{"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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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":"Successful response"},"400":{"content":{"application/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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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":"Successful response"},"400":{"content":{"application/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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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/threads":{"post":{"description":"Returns the list of threads for specific user\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"}}},"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Moderation v2 ban\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":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Moderation v2 check\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":"Moderation v2 check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Moderation v2 upsert configuration\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":"Moderation v2 upsert 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":{"type":"string","x-stream-index":"001"}}],"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":"Moderation v2 get configuration\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string","x-stream-index":"001"}}],"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":"Moderation v2 get configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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 configs","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Moderation v2 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":"Moderation v2 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 (hard limit of 100 templates)\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":"Moderation v2 query feed templates","tags":["product:moderation"]},"post":{"description":"Moderation v2 upsert feeds template\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":"Moderation v2 upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Query review queue items allows you to filter the moderation logs. This is used for building a moderation dashboard.\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/moderator_stats":{"get":{"description":"Moderation v2 moderator stats\n","operationId":"get_moderator_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModeratorStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 moderator stats","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 mute","tags":["product:moderation"]}},"/api/v2/moderation/queue_stats":{"get":{"description":"Moderation v2 queue stats\n","operationId":"get_queue_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 queue stats","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":"Moderation v2 get review queue item\n","operationId":"get_review_queue_item","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/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":"Moderation v2 get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Moderation v2 submit action\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":"Moderation v2 submit action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Moderation v2 unban\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":"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":"Moderation v2 unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Moderation V2 unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation V2 unmute a user","tags":["product:moderation"]}},"/api/v2/moderation/usage_stats":{"post":{"description":"Query usage stats\n","operationId":"query_usage_stats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Query usage stats","tags":["product:moderation"]}},"/api/v2/moderation/user_report":{"get":{"description":"Moderation v2 get user moderation report\n","operationId":"get_user_report","parameters":[{"in":"query","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"create_user_if_not_exists","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"include_user_mutes","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"include_user_blocks","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserModerationReportResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get user moderation report","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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"description":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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":"Successful response"},"400":{"content":{"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/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCallStats\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"Call"},"400":{"content":{"application/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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- SendEvent\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"Successful response"},"400":{"content":{"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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- EndCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteUsers\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListRecordings\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":"Successful response"},"400":{"content":{"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}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n\nRequired permissions:\n- StartBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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":"Successful response"},"400":{"content":{"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartTranscription\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":"Successful response"},"400":{"content":{"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopRecording\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopTranscription\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListTranscriptions\n","operationId":"ListTranscriptions","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/ListTranscriptionsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCallPermissions\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteRecording\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteTranscription\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://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","notification_template"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionConfig":{"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"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","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":{"format":"date-time","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"001"},"reason":{"type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"009"},"target_user_id":{"type":"string","x-stream-index":"010"},"type":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"type":"object"},"AppResponseFields":{"properties":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"039"},"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":"042"},"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"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"041"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"040"},"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_enabled":{"type":"boolean","x-stream-index":"043"},"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"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"video_provider":{"type":"string","x-stream-index":"038"},"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"],"type":"object"},"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":"021"},"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":"022"},"image_url":{"type":"string","x-stream-index":"011"},"latitude":{"format":"float","type":"number","x-stream-index":"018"},"longitude":{"format":"float","type":"number","x-stream-index":"019"},"og_scrape_url":{"type":"string","x-stream-index":"023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"024"},"pretext":{"type":"string","x-stream-index":"004"},"stopped_sharing":{"type":"boolean","x-stream-index":"020"},"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"],"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":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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"},"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":"005"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008"},"banned_by_id":{"type":"string","x-stream-index":"007"},"channel_cid":{"type":"string","x-stream-index":"004"},"ip_ban":{"type":"boolean","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"003"},"shadow":{"type":"boolean","x-stream-index":"005"},"target_user_id":{"type":"string","x-stream-index":"001"},"timeout":{"minimum":0,"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"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"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","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"003"},"type":{"description":"Block list type.","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":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"005"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","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"},"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"},"BodyguardConfig":{"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"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","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"],"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"},"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"},"CallEvent":{"nullable":true,"properties":{"category":{"type":"string","x-stream-index":"009"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"issue_tags":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"kind":{"type":"string","x-stream-index":"008"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal","kind"],"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"},"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"},"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"},"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"],"title":"CallRecording","type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"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"},"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"},"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":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"007"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"009"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"008"},"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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"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"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"title":"CallTranscription","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"},"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"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"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":"014"},"create_channels":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"018"},"description":{"type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"013"},"name":{"type":"string","x-stream-index":"006"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"011"},"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"},"skip_push":{"type":"boolean","x-stream-index":"009"},"skip_webhook":{"type":"boolean","x-stream-index":"010"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"017"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"019"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"016"}},"required":["id","segment_ids","segments","sender_id","name","create_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"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"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"003"}},"type":"object"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"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":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"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":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.025"},"blocklist":{"type":"string","x-stream-index":"001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.023"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.028"},"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"}},"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","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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.028"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"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"},"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"},"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":{"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","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","create-call","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-call","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-typing-events","set-channel-cooldown","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"},"ChannelStateResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.010"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.011"},"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.012"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"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.009"},"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":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"010"},"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":"011"},"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":"012"},"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"},"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":"009"},"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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.028"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"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"},"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":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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":"007.001"},"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":"004"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"005"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"006"},"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":{"type":"string","x-stream-index":"005"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"test_mode":{"type":"boolean","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"004"},"recommended_action":{"type":"string","x-stream-index":"003"},"status":{"type":"string","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"title":"Response","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"},"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":["user_session_id","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"},"Config":{"properties":{"app_certificate":{"type":"string","x-stream-index":"002"},"app_id":{"type":"string","x-stream-index":"001"},"default_role":{"enum":["attendee","publisher","subscriber","admin"],"type":"string","x-stream-index":"003"},"role_map":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["app_id","app_certificate"],"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"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key","async","created_at","updated_at"],"type":"object"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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"},"type":{"description":"Block list type.","enum":["regex","domain","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"},"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":"017"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"018"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"022"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"023"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"024"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"019"},"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":"021"},"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":"016"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"015"},"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":"025"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"026"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"020"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"027"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.025"},"blocklist":{"type":"string","x-stream-index":"001.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.028"},"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"}},"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","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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"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":"004"},"position":{"format":"int32","type":"integer","x-stream-index":"003"},"text":{"description":"Option text","title":"string","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"}},"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"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"004"},"name":{"type":"string","x-stream-index":"006"},"reason":{"type":"string","x-stream-index":"007"},"recommended_action":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CustomCheckResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"008.001"},"id":{"type":"string","x-stream-index":"001"},"moderator_action":{"type":"string","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"002"},"report":{"additionalProperties":{},"type":"array","x-stream-index":"004"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"007"},"scored_at":{"format":"date-time","type":"number","x-stream-index":"005"},"status":{"type":"string","x-stream-index":"003"}},"required":["id","recommended_action","status","report","scored_at","duration"],"title":"Response","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":{"description":"Basic response information","nullable":true,"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"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"},"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"},"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.006"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.005"},"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"},"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"}},"required":["playlist_url"],"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"},"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"},"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":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.016"},"banned":{"type":"boolean","x-stream-index":"001.015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"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.022"},"language":{"type":"string","x-stream-index":"001.033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"001.024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.040"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"}},"required":["id","role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"description":"User response object","properties":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"001.003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.001.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.001.010"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001.006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.001.013"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.001.014"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"001.002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.001.007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible","ban_count","deleted_content_count"],"title":"UserResponse","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"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled","apns"],"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":25,"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"},"ExportChannelsResult":{"properties":{"path":{"description":"S3 path of result","title":"PathPrefix","type":"string","x-stream-index":"002"},"s3_bucket_name":{"description":"S3 bucket name result","title":"S3 bucket name","type":"string","x-stream-index":"003"},"url":{"description":"URL of result","title":"URL","type":"string","x-stream-index":"001"}},"required":["url"],"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"},"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":"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","notification_template","data_template","apn_template"],"type":"object"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"Flag2Response":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"014"},"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_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["user_id","entity_type","entity_id","result","created_at","updated_at"],"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":{},"type":"object","x-stream-index":"006"},"entity_creator_id":{"type":"string","x-stream-index":"003"},"entity_id":{"type":"string","x-stream-index":"002"},"entity_type":{"type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"005"},"reason":{"maxLength":255,"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item_id":{"type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"title":"Response","type":"object"},"FullUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"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"},"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.009"}},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"},"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"},"GetCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"title":"Response","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":"002.001"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.025"},"blocklist":{"type":"string","x-stream-index":"003.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.028"},"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"}},"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","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":{"description":"Basic response information","nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"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"},"GetExportChannelsStatusResponse":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.007.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Contains task error in case of failure","title":"Error","x-stream-index":"003"},"result":{"$ref":"#/components/schemas/ExportChannelsResult","description":"Contains task result in case of success","title":"ExportChannelsResult","x-stream-index":"002"},"status":{"description":"Task status","enum":["waiting","pending","running","completed","failed","canceled"],"title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"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.021"},"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.022"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"latitude":{"format":"float","type":"number","x-stream-index":"001.018"},"longitude":{"format":"float","type":"number","x-stream-index":"001.019"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.024"},"pretext":{"type":"string","x-stream-index":"001.004"},"stopped_sharing":{"type":"boolean","x-stream-index":"001.020"},"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"},"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"history":{"items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"type":"array","x-stream-index":"002"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"001"}},"required":["history","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":"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"},"GetUserModerationReportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_blocks":{"items":{"$ref":"#/components/schemas/UserBlock"},"type":"array","x-stream-index":"003"},"user_mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"002"}},"required":["user","user_mutes","user_blocks","duration"],"title":"Response","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"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"}},"required":["enabled"],"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"},"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":"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"},"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":{"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":{"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","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"},"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"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"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"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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"},"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":"011"},"before_message_send_failed":{"type":"boolean","x-stream-index":"045"},"cid":{"type":"string","x-stream-index":"027"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"043"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"039"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"012"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"051"},"mml":{"type":"string","x-stream-index":"005"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"parent_id":{"type":"string","x-stream-index":"018"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"050"},"pinned":{"type":"boolean","x-stream-index":"046"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"047"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"024"},"quoted_message_id":{"type":"string","x-stream-index":"023"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"021"},"shadowed":{"type":"boolean","x-stream-index":"035"},"show_in_channel":{"type":"boolean","x-stream-index":"020"},"silent":{"type":"boolean","x-stream-index":"044"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"026"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","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"},"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"},"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"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"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":"008"},"last_read_message_id":{"type":"string","x-stream-index":"009"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["cid","channel_id","channel_type","type","created_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":25,"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":"038"},"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":{"enum":["''regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"020.002"},"user_id":{"type":"string","x-stream-index":"020.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":"021"},"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":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"017"},"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":"029"},"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":"027"},"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":"028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"035"},"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"},"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":"014"},"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":"034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"031"},"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":"032"},"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":"033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"018"},"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":"013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"016"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"026"},"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":"015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"030"},"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":"020"},"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":"023"},"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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"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.021"},"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.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"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.029"},"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.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"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"},"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.014"},"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.034"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.031"},"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.032"},"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.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.036"},"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.019"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.018"},"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.013"},"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"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.016"},"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.026"},"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.015"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.030"},"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.020"},"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.023"},"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","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"ModerationUsageStats":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"004"},"id":{"format":"int32","type":"integer","x-stream-index":"003"},"organization_id":{"format":"int32","type":"integer","x-stream-index":"005"},"reference_date":{"format":"date-time","type":"number","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"usage_amount":{"format":"int32","type":"integer","x-stream-index":"008"},"usage_type":{"type":"string","x-stream-index":"007"}},"required":["id","app_pk","organization_id","reference_date","usage_type","usage_amount","updated_at"],"type":"object"},"ModeratorStats":{"nullable":true,"properties":{"action_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"items_reviewed":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["id","items_reviewed","action_counts"],"type":"object"},"ModeratorStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"moderator_stats":{"items":{"$ref":"#/components/schemas/ModeratorStats"},"type":"array","x-stream-index":"001"}},"required":["moderator_stats","duration"],"title":"Response","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"},"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"banned":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"043"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"028"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"026"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"011"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"027"},"online":{"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"031"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"029"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"032"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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"},"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"},"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":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"021"},"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"},"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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2"],"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"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"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"},"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"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"006"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"title":"Limit","type":"integer","x-stream-index":"004"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"005"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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"},"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":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"}},"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"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"templates":{"items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"type":"array","x-stream-index":"001"}},"required":["templates","duration"],"title":"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"},"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":{},"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/SortParamRequest"},"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":{"description":"Basic response information","nullable":true,"properties":{"configs":{"items":{"$ref":"#/components/schemas/ConfigResponse"},"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"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"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/SortParamRequest"},"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":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"logs":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"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"],"title":"Response","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"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"format":"int32","maximum":25,"minimum":1,"type":"integer","x-stream-index":"005"},"lock_duration":{"type":"integer","x-stream-index":"004"},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"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":{"description":"Basic response information","nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"type":"object","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"items":{"items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"title":"Response","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":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"006.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":"006.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"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.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"},"QueryUsageStatsRequest":{"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/SortParamRequest"},"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"},"QueryUsageStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"items":{"items":{"$ref":"#/components/schemas/ModerationUsageStats"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["items","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"},"QueueStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"avg_time_to_action":{"type":"integer","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"time_to_action_buckets":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"}},"required":["avg_time_to_action","time_to_action_buckets","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"},"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"},"ReactionRemovalResponse":{"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/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"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"},"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"},"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":"028"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"025"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"026"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"017"},"content_changed":{"type":"boolean","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"024"},"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":"030"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"031"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"027"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"023"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"016"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"020"},"reviewed_by":{"type":"string","x-stream-index":"021"},"severity":{"format":"int32","type":"integer","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"015"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLogResponse"},"type":"array","x-stream-index":"020"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"018"},"completed_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","x-stream-index":"015"},"entity_creator_id":{"type":"string","x-stream-index":"016"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"021"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"022"},"flags":{"items":{"$ref":"#/components/schemas/Flag2Response"},"type":"array","x-stream-index":"019"},"id":{"type":"string","x-stream-index":"001"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"006"},"recommended_action":{"type":"string","x-stream-index":"008"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"010"},"reviewed_by":{"type":"string","x-stream-index":"011"},"severity":{"format":"int32","type":"integer","x-stream-index":"013"},"status":{"type":"string","x-stream-index":"007"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","bans","flags","actions"],"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":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"S3Request":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"type":"object"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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":"004"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"007"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"005"},"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":"006"}},"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.021"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.025"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.029"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.027"},"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.028"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.035"},"mml":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.014"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.034"},"pinned":{"type":"boolean","x-stream-index":"001.031"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.032"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.033"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.037"},"poll_id":{"type":"string","x-stream-index":"001.036"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.019"},"quoted_message_id":{"type":"string","x-stream-index":"001.018"},"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.013"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.016"},"shadowed":{"type":"boolean","x-stream-index":"001.026"},"show_in_channel":{"type":"boolean","x-stream-index":"001.015"},"silent":{"type":"boolean","x-stream-index":"001.030"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.020"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"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"],"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"},"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":"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":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartTranscriptionRequest","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,"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"},"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,"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,"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":{"enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock"],"type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","x-stream-index":"006"},"item_id":{"type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"013.002"},"user_id":{"type":"string","x-stream-index":"013.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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"},"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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"languages":{"description":"the languages to transcribe to","items":{"type":"string"},"maximum":2,"title":"array","type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"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"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"],"title":"Language","type":"string","x-stream-index":"002"}},"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"},"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":"007.002"},"user_id":{"type":"string","x-stream-index":"007.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","x-stream-index":"005"},"unbanned_by_id":{"type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","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"},"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":"004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"003"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"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":{"agora_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.040"},"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.042"},"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.043"},"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"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.045"},"feeds_v2_region":{"type":"string","x-stream-index":"001.044"},"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"},"hms_options":{"$ref":"#/components/schemas/Config","x-stream-index":"001.041"},"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_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_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"video_provider":{"enum":["agora","hms"],"type":"string","x-stream-index":"001.039"},"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":{"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.025"},"blocklist":{"type":"string","x-stream-index":"009.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.023"},"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.018"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.028"},"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"}},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.025"},"blocklist":{"type":"string","x-stream-index":"003.001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.028"},"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"}},"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","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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"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"},"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":"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"},"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"},"UpsertConfigRequest":{"nullable":true,"properties":{"async":{"type":"boolean","x-stream-index":"002"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","x-stream-index":"004"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","x-stream-index":"005"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","x-stream-index":"003"},"aws_rekognition_config":{"$ref":"#/components/schemas/AWSRekognitionConfig","x-stream-index":"009"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","x-stream-index":"006"},"bodyguard_config":{"$ref":"#/components/schemas/BodyguardConfig","x-stream-index":"007"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","x-stream-index":"008"},"key":{"type":"string","x-stream-index":"001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","x-stream-index":"010"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"description":"Basic response information","nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","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"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"name":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"title":"Response","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":{"ban_expires":{"format":"date-time","type":"number","x-stream-index":"016"},"banned":{"type":"boolean","x-stream-index":"015"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"040"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"type":"object"},"UserBlock":{"nullable":true,"properties":{"blocked_by_user_id":{"type":"string","x-stream-index":"005"},"blocked_user_id":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"002"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"005"}},"required":["id","name","image","custom","roles"],"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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.010"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"type":"object"},"VelocityFilterConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"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"],"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"},"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"}},"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"],"type":"object"},"VideoDimension":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoDimension","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"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":{"Option":{"$ref":"#/components/schemas/PollOptionResponseData","x-stream-index":"003"},"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":"021"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"022"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"009"},"channel_id":{"type":"string","x-stream-index":"004"},"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":"026"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"020"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"025"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"017"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"007"},"parent_id":{"type":"string","x-stream-index":"023"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"013"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"014"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"024"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"011"},"thread_id":{"type":"string","x-stream-index":"010"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"015"},"user_id":{"type":"string","x-stream-index":"016"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"018"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.004"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.003"},"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.005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"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":"v137.0.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","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/Response"}}},"description":"Response"},"400":{"content":{"application/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":{"description":"Block list 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 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"}}],"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/Response"}}},"description":"Response"},"400":{"content":{"application/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\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 campaign","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"}}],"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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteChannel\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\nRequired permissions:\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\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\nRequired permissions:\n- AddOwnChannelMembership\n- RemoveOwnChannelMembership\n- UpdateChannel\n- UpdateChannelCooldown\n- UpdateChannelFrozen\n- UpdateChannelMembers\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}/event":{"post":{"description":"Sends event to the channel\n\nRequired permissions:\n- SendCustomEvent\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteAttachment\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\nRequired permissions:\n- UploadAttachment\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/{user_id}":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"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\nRequired permissions:\n- AddLinks\n- CreateMessage\n- PinMessage\n- SkipChannelCooldown\n- SkipMessageModeration\n- UseFrozenChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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","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 channel\n\nSends events:\n- channel.truncated\n\nRequired permissions:\n- DeleteChannel\n- TruncateChannel\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\nRequired permissions:\n- ReadChannel\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/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/export_channels/{id}":{"get":{"description":"\n","operationId":"GetExportChannelsStatus","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/GetExportChannelsStatusResponse"}}},"description":"Successful response"},"400":{"content":{"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 status","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- DeleteMessage\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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\nRequired permissions:\n- AddLinks\n- PinMessage\n- SkipMessageModeration\n- UpdateMessage\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\nRequired permissions:\n- RunMessageAction\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","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\nRequired permissions:\n- CreateReaction\n- UseFrozenChannel\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\nRequired permissions:\n- DeleteReaction\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/ReactionRemovalResponse"}}},"description":"Response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.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","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"003.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- poll.vote_casted\n\nRequired permissions:\n- CastVote\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":"002"}}],"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- poll.vote_removed\n\nRequired permissions:\n- CastVote\n","operationId":"RemovePollVote","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":"003"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"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/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n\nRequired permissions:\n- ReadChannel\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":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"format":"int32","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"format":"date-time","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"format":"date-time","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"format":"date-time","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"format":"date-time","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\nRequired permissions:\n- ReadMessageFlags\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\nRequired permissions:\n- MuteChannel\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\nRequired permissions:\n- MuteChannel\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/polls":{"post":{"description":"Creates a new poll\n\nRequired permissions:\n- CreatePoll\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- poll.closed\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- poll.deleted\n\nRequired permissions:\n- DeletePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- CastVote\n- UpdatePoll\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- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/chat/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- poll.updated\n\nRequired permissions:\n- UpdatePoll\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"]}},"/api/v2/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"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n\nRequired permissions:\n- ReadChannel\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/search":{"get":{"description":"Search messages across channels\n\nRequired permissions:\n- ReadChannel\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":"ControllerNameQuerySegmentTargets","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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\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\nRequired permissions:\n- ReadChannel\n- UpdateThread\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"}}},"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"}}},"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":"Moderation v2 ban\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 ban","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Moderation v2 check\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Moderation v2 upsert configuration\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 upsert 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":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Response"},"400":{"content":{"application/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":"Moderation v2 get configuration\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Query moderation configs. This is used for building a moderation dashboard.\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":"Response"},"400":{"content":{"application/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 configs","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Moderation v2 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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 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":"Response"},"400":{"content":{"application/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 (hard limit of 100 templates)\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 query feed templates","tags":["product:moderation"]},"post":{"description":"Moderation v2 upsert feeds template\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Moderation v2 flag\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":"Moderation v2 flag","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Query review queue items allows you to filter the moderation logs. This is used for building a moderation dashboard.\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":"Response"},"400":{"content":{"application/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/moderator_stats":{"get":{"description":"Moderation v2 moderator stats\n","operationId":"get_moderator_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModeratorStatsResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 moderator stats","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Moderation v2 mute\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":"Moderation v2 mute","tags":["product:moderation"]}},"/api/v2/moderation/queue_stats":{"get":{"description":"Moderation v2 queue stats\n","operationId":"get_queue_stats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatsResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 queue stats","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":"Response"},"400":{"content":{"application/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":"Moderation v2 get review queue item\n","operationId":"get_review_queue_item","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/GetReviewQueueItemResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Moderation v2 submit action\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":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 submit action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Moderation v2 unban\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":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Moderation V2 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":"Moderation V2 unmute a user","tags":["product:moderation"]}},"/api/v2/moderation/usage_stats":{"post":{"description":"Query usage stats\n","operationId":"query_usage_stats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsageStatsResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Query usage stats","tags":["product:moderation"]}},"/api/v2/moderation/user_report":{"get":{"description":"Moderation v2 get user moderation report\n","operationId":"get_user_report","parameters":[{"in":"query","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"create_user_if_not_exists","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"include_user_mutes","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"include_user_blocks","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserModerationReportResponse"}}},"description":"Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests"}},"summary":"Moderation v2 get user moderation report","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/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/users":{"get":{"description":"Find and filter users\n\nRequired permissions:\n- SearchUser\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.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/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\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/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- ReadCallStats\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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- DeleteCall\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\nRequired permissions:\n- SendEvent\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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- EndCall\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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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\nRequired permissions:\n- MuteUsers\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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- ListRecordings\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}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StartClosedCaptions\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"}}],"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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\nRequired permissions:\n- StartTranscription\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"}}},"description":"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopClosedCaptions\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"}}],"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"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\nRequired permissions:\n- StopRecording\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\nRequired permissions:\n- StopTranscription\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"}}],"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\nRequired permissions:\n- ListTranscriptions\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- UpdateCallPermissions\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\nRequired permissions:\n- DeleteRecording\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\nRequired permissions:\n- DeleteTranscription\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\nRequired permissions:\n- ReadCall\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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/serverside-api.yaml b/openapi/serverside-api.yaml index 4dba3ad1..44f06d9b 100644 --- a/openapi/serverside-api.yaml +++ b/openapi/serverside-api.yaml @@ -148,14 +148,17 @@ components: type: object AWSRekognitionConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -233,7 +236,7 @@ components: type: string x-stream-index: "012" target_user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "013" target_user_id: type: string @@ -242,7 +245,7 @@ components: type: string x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "007" required: - id @@ -255,6 +258,7 @@ components: - review_queue_item_id type: object ActionLogResponse: + nullable: true properties: created_at: format: date-time @@ -263,31 +267,39 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "006" + x-stream-index: "007" id: type: string x-stream-index: "001" reason: type: string - x-stream-index: "005" + x-stream-index: "006" review_queue_item: $ref: '#/components/schemas/ReviewQueueItem' - x-stream-index: "007" + x-stream-index: "008" target_user: $ref: '#/components/schemas/UserResponse' - x-stream-index: "008" + x-stream-index: "009" + target_user_id: + type: string + x-stream-index: "010" type: type: string x-stream-index: "003" user: $ref: '#/components/schemas/UserResponse' x-stream-index: "004" + user_id: + type: string + x-stream-index: "005" required: - id - created_at - type + - user_id - reason - custom + - target_user_id type: object AggregatedStats: properties: @@ -520,6 +532,8 @@ components: 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: @@ -545,7 +559,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "018" + x-stream-index: "021" fallback: type: string x-stream-index: "002" @@ -562,24 +576,35 @@ components: x-stream-index: "014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "019" + x-stream-index: "022" image_url: type: string x-stream-index: "011" + latitude: + format: float + type: number + x-stream-index: "018" + longitude: + format: float + type: number + x-stream-index: "019" og_scrape_url: type: string - x-stream-index: "020" + x-stream-index: "023" original_height: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "025" original_width: format: int32 type: integer - x-stream-index: "021" + x-stream-index: "024" pretext: type: string x-stream-index: "004" + stopped_sharing: + type: boolean + x-stream-index: "020" text: type: string x-stream-index: "010" @@ -721,14 +746,17 @@ components: type: object AutomodPlatformCircumventionConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -758,14 +786,17 @@ components: type: object AutomodSemanticFiltersConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -795,14 +826,17 @@ components: type: object AutomodToxicityConfig: properties: - enabled: + 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: "002" + x-stream-index: "003" required: - enabled - rules @@ -872,7 +906,7 @@ components: type: number x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "011" expires: format: date-time @@ -885,7 +919,7 @@ components: type: boolean x-stream-index: "009" target: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "006" required: - shadow @@ -896,6 +930,9 @@ components: channel_ban_only: type: boolean x-stream-index: "003" + ip_ban: + type: boolean + x-stream-index: "004" reason: type: string x-stream-index: "002" @@ -905,7 +942,7 @@ components: timeout: format: int32 type: integer - x-stream-index: "004" + x-stream-index: "005" type: object BanRequest: nullable: true @@ -969,14 +1006,17 @@ components: type: object BlockListConfig: properties: - enabled: + async: type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" rules: items: $ref: '#/components/schemas/BlockListRule' type: array - x-stream-index: "002" + x-stream-index: "003" required: - enabled - rules @@ -984,13 +1024,17 @@ components: 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: @@ -1054,6 +1098,7 @@ components: - action type: object BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. nullable: true properties: user_id: @@ -1063,8 +1108,10 @@ components: 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: @@ -1074,6 +1121,7 @@ components: x-stream-index: "001.001" required: - duration + title: BlockUserResponse type: object BlockUsersRequest: nullable: true @@ -1158,22 +1206,25 @@ components: type: object BodyguardConfig: properties: - enabled: + async: type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" profile: type: string - x-stream-index: "002" + x-stream-index: "003" rules: items: $ref: '#/components/schemas/BodyguardRule' type: array - x-stream-index: "003" + x-stream-index: "004" severity_rules: items: $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "004" + x-stream-index: "005" required: - enabled - profile @@ -1250,28 +1301,32 @@ components: 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 CallEvent: nullable: true properties: - additional: - additionalProperties: {} - type: object - x-stream-index: "008" + category: + type: string + x-stream-index: "009" component: type: string x-stream-index: "007" @@ -1285,6 +1340,14 @@ components: internal: type: boolean x-stream-index: "006" + issue_tags: + items: + type: string + type: array + x-stream-index: "010" + kind: + type: string + x-stream-index: "008" severity: format: int32 type: integer @@ -1303,15 +1366,18 @@ components: - description - type - internal + - kind 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: Call inputs + title: CallIngressResponse type: object CallParticipantResponse: properties: @@ -1360,8 +1426,10 @@ components: - url - start_time - end_time + title: CallRecording type: object CallRequest: + description: CallRequest is the payload for creating a call. properties: created_by: $ref: '#/components/schemas/UserRequest' @@ -1394,18 +1462,22 @@ components: video: type: boolean x-stream-index: "008" + title: CallRequest type: object CallResponse: description: Represents a call properties: backstage: type: boolean - x-stream-index: "015" + x-stream-index: "016" blocked_user_ids: items: type: string type: array - x-stream-index: "017" + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" cid: description: The unique identifier for a call (:) title: CID @@ -1433,13 +1505,13 @@ components: x-stream-index: "008" egress: $ref: '#/components/schemas/EgressResponse' - x-stream-index: "020" + x-stream-index: "021" ended_at: description: Date/time when the call ended format: date-time title: Ended At type: number - x-stream-index: "013" + x-stream-index: "014" id: description: Call ID title: ID @@ -1447,32 +1519,32 @@ components: x-stream-index: "003" ingress: $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "018" + x-stream-index: "019" join_ahead_time_seconds: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "023" recording: type: boolean x-stream-index: "011" session: $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "019" + x-stream-index: "020" settings: $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "016" + 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: "014" + x-stream-index: "015" team: type: string x-stream-index: "006" thumbnails: $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "021" + x-stream-index: "022" transcribing: type: boolean x-stream-index: "012" @@ -1498,12 +1570,13 @@ components: - updated_at - recording - transcribing + - captioning - backstage - settings - blocked_user_ids - ingress - egress - title: Call + title: CallResponse type: object CallSessionResponse: properties: @@ -1693,6 +1766,7 @@ components: - limits type: object CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response properties: call: $ref: '#/components/schemas/CallResponse' @@ -1714,6 +1788,7 @@ components: - members - own_capabilities - blocked_users + title: CallStateResponseFields type: object CallStatsReportSummaryResponse: properties: @@ -1785,6 +1860,7 @@ components: - url - start_time - end_time + title: CallTranscription type: object CallType: nullable: true @@ -1832,12 +1908,17 @@ components: - 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: @@ -1845,19 +1926,29 @@ components: 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: @@ -1867,140 +1958,308 @@ components: - notification_settings - created_at - updated_at + title: CallTypeResponse type: object - CastPollVoteRequest: - nullable: true - properties: - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "004.002" - user_id: - type: string - x-stream-index: "004.001" - vote: - $ref: '#/components/schemas/VoteData' - description: Vote data - title: VoteData - x-stream-index: "003" - type: object - Channel: + CampaignChannelTemplate: properties: - auto_translation_enabled: - type: boolean - x-stream-index: "028" - auto_translation_language: - type: string - x-stream-index: "029" - cid: - type: string - x-stream-index: "003" - config: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "025" - config_overrides: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "026" - cooldown: - format: int32 - type: integer - x-stream-index: "030" - created_at: - format: date-time - type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "008" custom: additionalProperties: {} type: object - x-stream-index: "018" - 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" + x-stream-index: "004" id: type: string - x-stream-index: "004" - invites: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "021" - last_message_at: - format: date-time - type: number - x-stream-index: "006" - member_count: - format: int32 - type: integer - x-stream-index: "020" + x-stream-index: "002" members: items: - $ref: '#/components/schemas/ChannelMember' + type: string + maximum: 1000 type: array - x-stream-index: "019" - team: - type: string - x-stream-index: "027" - truncated_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "015" + x-stream-index: "003" type: + maxLength: 64 type: string - x-stream-index: "005" - updated_at: - format: date-time - type: number - x-stream-index: "010" + x-stream-index: "001" required: - - cid - - id - type - - created_at - - updated_at - - frozen - - disabled - custom - - auto_translation_language type: object - ChannelConfig: - nullable: true + CampaignMessageTemplate: properties: - allowed_flag_reasons: + attachments: items: - type: string + $ref: '#/components/schemas/Attachment' + maximum: 30 type: array - x-stream-index: "001.024" - automod: - enum: - - disabled - - simple - - AI - type: string - x-stream-index: "001.019" - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + poll_id: type: string - x-stream-index: "001.020" - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.025" - blocklist: + x-stream-index: "003" + text: type: string - x-stream-index: "001.021" - blocklist_behavior: - enum: - - flag + x-stream-index: "001" + required: + - text + - attachments + - poll_id + - custom + type: object + CampaignResponse: + properties: + channel_template: + $ref: '#/components/schemas/CampaignChannelTemplate' + x-stream-index: "014" + create_channels: + type: boolean + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "018" + description: + type: string + x-stream-index: "008" + id: + type: string + x-stream-index: "001" + message_template: + $ref: '#/components/schemas/CampaignMessageTemplate' + x-stream-index: "013" + name: + type: string + x-stream-index: "006" + scheduled_for: + format: date-time + type: number + x-stream-index: "011" + 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" + skip_push: + type: boolean + x-stream-index: "009" + skip_webhook: + type: boolean + x-stream-index: "010" + stats: + $ref: '#/components/schemas/CampaignStatsResponse' + x-stream-index: "020" + status: + type: string + x-stream-index: "017" + stop_at: + format: date-time + type: number + x-stream-index: "012" + updated_at: + format: date-time + type: number + x-stream-index: "019" + user_ids: + items: + type: string + type: array + x-stream-index: "015" + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "016" + required: + - id + - segment_ids + - segments + - sender_id + - name + - create_channels + - description + - skip_push + - skip_webhook + - user_ids + - users + - status + - created_at + - updated_at + - stats + type: object + 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" + required: + - stats_started_at + - stats_completed_at + - stats_messages_sent + - stats_channels_created + - progress + type: object + CastPollVoteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + vote: + $ref: '#/components/schemas/VoteData' + description: Vote data + title: VoteData + x-stream-index: "003" + type: object + Channel: + properties: + auto_translation_enabled: + type: boolean + x-stream-index: "028" + auto_translation_language: + type: string + x-stream-index: "029" + cid: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "025" + config_overrides: + $ref: '#/components/schemas/ConfigOverrides' + x-stream-index: "026" + cooldown: + format: int32 + type: integer + x-stream-index: "030" + 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: "018" + 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: "021" + last_message_at: + format: date-time + type: number + x-stream-index: "006" + member_count: + format: int32 + type: integer + x-stream-index: "020" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "019" + team: + type: string + x-stream-index: "027" + 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: + nullable: true + properties: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: "001.024" + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: "001.019" + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.020" + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: "001.025" + blocklist: + type: string + x-stream-index: "001.021" + blocklist_behavior: + enum: + - flag - block - shadow_block type: string @@ -2011,8 +2270,10 @@ components: type: array x-stream-index: "001.023" commands: + description: List of commands that channel supports items: type: string + title: Commands type: array x-stream-index: "003" connect_events: @@ -2039,6 +2300,16 @@ components: name: type: string x-stream-index: "001.001" + partition_size: + format: int32 + type: integer + x-stream-index: "001.026" + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: "001.027" polls: type: boolean x-stream-index: "001.016" @@ -2063,6 +2334,9 @@ components: search: type: boolean x-stream-index: "001.005" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.028" typing_events: type: boolean x-stream-index: "001.002" @@ -2097,6 +2371,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - created_at - updated_at - commands @@ -2160,13 +2435,8 @@ components: items: type: string type: array - title: Grants type: object x-stream-index: "002" - x-stream-map: - description: List of grants modifiers that apply to a role - key: role - title: Grants mark_messages_pending: type: boolean x-stream-index: 001.002.015 @@ -2215,6 +2485,9 @@ components: search: type: boolean x-stream-index: 001.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.028 typing_events: type: boolean x-stream-index: 001.002.002 @@ -2251,6 +2524,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands type: object ChannelExport: @@ -2369,82 +2643,101 @@ components: 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: "017" + x-stream-index: "013" banned: description: Whether member is banned this channel or not title: Banned type: boolean - x-stream-index: "016" + x-stream-index: "012" channel_role: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "021" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "012" + x-stream-index: "009" custom: additionalProperties: {} type: object - x-stream-index: "006" + x-stream-index: "004" deleted_at: format: date-time type: number - x-stream-index: "014" + 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: "009" + 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: "010" + x-stream-index: "007" invited: description: Whether member was invited or not title: Invited type: boolean - x-stream-index: "008" + x-stream-index: "005" is_moderator: description: Whether member is channel moderator or not title: Is moderator type: boolean - x-stream-index: "007" + x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "022" + 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: "019" + x-stream-index: "014" status: type: string - x-stream-index: "011" + x-stream-index: "008" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "013" + x-stream-index: "010" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "005" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" user_id: title: User ID type: string - x-stream-index: "004" + x-stream-index: "001" required: - custom - created_at @@ -2457,6 +2750,10 @@ components: type: object ChannelMemberResponse: properties: + archived_at: + format: date-time + type: number + x-stream-index: "016" ban_expires: description: Expiration date of the ban format: date-time @@ -2472,7 +2769,7 @@ components: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "016" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time @@ -2511,7 +2808,11 @@ components: x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "017" + 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)' @@ -2522,7 +2823,7 @@ components: - owner title: Role type: string - x-stream-index: "015" + x-stream-index: "017" shadow_banned: description: Whether member is shadow banned in this channel or not title: Shadow banned @@ -2559,34 +2860,75 @@ components: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "007" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "009" + x-stream-index: "004" expires: description: Date/time of mute expiration format: date-time title: Expires type: number - x-stream-index: "008" + x-stream-index: "003" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "010" + x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Owner of channel mute title: User - x-stream-index: "005" + 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 + - create-call + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-call + - 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-typing-events + - set-channel-cooldown + - 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: @@ -2594,141 +2936,143 @@ components: description: Whether auto translation is enabled or not title: Auto translation type: boolean - x-stream-index: "021" + 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: "022" + x-stream-index: "018" blocked: description: Whether this channel is blocked by current user or not title: Blocked type: boolean - x-stream-index: "027" + x-stream-index: "023" cid: description: Channel CID (:) title: CID type: string - x-stream-index: "005" + x-stream-index: "003" config: $ref: '#/components/schemas/ChannelConfigWithInfo' description: Channel configuration - title: Config - x-stream-index: "017" + title: ChannelConfigWithInfo + x-stream-index: "013" cooldown: description: Cooldown period after sending each message format: int32 title: Cooldown type: integer - x-stream-index: "024" + x-stream-index: "020" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "008" + x-stream-index: "005" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Creator of the channel - title: Created by - x-stream-index: "011" + title: UserResponse + x-stream-index: "008" custom: additionalProperties: {} + description: Custom data for this object + title: Custom data type: object - x-stream-index: "030" + x-stream-index: "026" deleted_at: description: Date/time of deletion format: date-time title: Deleted at type: number - x-stream-index: "010" + x-stream-index: "007" disabled: type: boolean - x-stream-index: "013" + x-stream-index: "010" frozen: description: Whether channel is frozen or not title: Frozen type: boolean - x-stream-index: "012" + x-stream-index: "009" hidden: description: Whether this channel is hidden by current user or not title: Hidden type: boolean - x-stream-index: "026" + 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: "023" + x-stream-index: "019" id: description: Channel unique ID title: ID type: string - x-stream-index: "003" + 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: "006" + x-stream-index: "004" member_count: description: Number of members in the channel format: int32 title: Member count type: integer - x-stream-index: "015" + x-stream-index: "012" members: description: List of channel members (max 100) items: $ref: '#/components/schemas/ChannelMember' - title: Members + title: ChannelMembers type: array - x-stream-index: "014" + x-stream-index: "011" mute_expires_at: description: Date of mute expiration format: date-time title: Mute expires at type: number - x-stream-index: "019" + x-stream-index: "015" muted: description: Whether this channel is muted or not title: Muted type: boolean - x-stream-index: "018" + x-stream-index: "014" own_capabilities: description: List of channel capabilities of authenticated user items: - type: string - title: Own Capabilities + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability type: array - x-stream-index: "025" + x-stream-index: "021" team: description: Team the channel belongs to (multi-tenant only) title: Team type: string - x-stream-index: "020" + x-stream-index: "016" truncated_at: description: Date of the latest truncation of the channel format: date-time - title: Truncated At + title: UserResponse type: number - x-stream-index: "028" + x-stream-index: "024" truncated_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "029" + $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: "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: "009" + x-stream-index: "006" required: - id - type @@ -2927,10 +3271,8 @@ components: type: array x-stream-index: 003.002.023 commands: - description: List of commands that channel supports items: $ref: '#/components/schemas/Command' - title: Commands type: array x-stream-index: "003.003" connect_events: @@ -3003,6 +3345,9 @@ components: search: type: boolean x-stream-index: 003.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.028 typing_events: type: boolean x-stream-index: 003.002.002 @@ -3041,9 +3386,11 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands type: object CheckExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -3057,8 +3404,10 @@ components: required: - duration - file_url + title: Response type: object CheckPushRequest: + description: Check push request nullable: true properties: apn_template: @@ -3110,6 +3459,7 @@ components: user_id: type: string x-stream-index: "008.001" + title: CheckPushRequest type: object CheckPushResponse: nullable: true @@ -3193,6 +3543,7 @@ components: - config_key type: object CheckResponse: + description: Basic response information nullable: true properties: duration: @@ -3216,6 +3567,7 @@ components: - status - recommended_action - duration + title: Response type: object CheckSNSRequest: nullable: true @@ -3349,6 +3701,7 @@ components: - rating type: object CollectUserFeedbackResponse: + description: Basic response information nullable: true properties: duration: @@ -3358,6 +3711,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Command: description: Represents custom chat command @@ -3432,6 +3786,56 @@ components: - app_id - app_certificate 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" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + required: + - grants + - commands + type: object ConfigResponse: properties: async: @@ -3559,9 +3963,12 @@ components: type: object x-stream-docs-page-id: block_lists 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: @@ -3569,6 +3976,8 @@ components: items: type: string type: array + description: the permissions granted to each role + title: Grants type: object x-stream-index: "002.001" name: @@ -3576,24 +3985,34 @@ components: 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: @@ -3601,19 +4020,29 @@ components: 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: @@ -3624,34 +4053,35 @@ components: - created_at - updated_at - duration + title: CreateCallTypeResponse type: object CreateChannelTypeRequest: nullable: true properties: automod: - description: Enables automatic message moderation + description: Automod enum: - disabled - simple - AI - title: Auto moderation + title: Automod type: string x-stream-index: "017" automod_behavior: - description: Sets behavior of automatic moderation + description: Automod behavior enum: - flag - block - title: Auto moderation behavior + title: Automod behavior type: string x-stream-index: "018" blocklist: - description: Name of the blocklist to use + description: Blocklist title: Blocklist type: string x-stream-index: "022" blocklist_behavior: - description: Sets behavior of blocklist + description: Blocklist behavior enum: - flag - block @@ -3660,8 +4090,10 @@ components: type: string x-stream-index: "023" blocklists: + description: Blocklists items: $ref: '#/components/schemas/BlockListOptions' + title: Blocklists type: array x-stream-index: "024" commands: @@ -3672,12 +4104,12 @@ components: type: array x-stream-index: "019" connect_events: - description: Connect events support + description: Connect events title: Connect events type: boolean x-stream-index: "004" custom_events: - description: Enables custom events + description: Custom events title: Custom events type: boolean x-stream-index: "011" @@ -3686,24 +4118,31 @@ components: items: type: string type: array + description: List of grants for the channel type + title: Grants type: object x-stream-index: "021" mark_messages_pending: - description: Marks messages as pending by default + description: Mark messages pending title: Mark messages pending type: boolean x-stream-index: "013" max_message_length: - description: Number of maximum message characters + description: Max message length format: int32 - title: Maximum message length + title: Max message length type: integer x-stream-index: "016" message_retention: + description: Message retention + enum: + - infinite + - numeric + title: Message retention type: string x-stream-index: "015" mutes: - description: Enables mutes + description: Mutes title: Mutes type: boolean x-stream-index: "008" @@ -3713,14 +4152,18 @@ components: type: string x-stream-index: "001" partition_size: + description: Partition size format: int32 minimum: 10 + title: Partition size type: integer x-stream-index: "025" partition_ttl: + description: Partition TTL example: 24h format: duration nullable: true + title: Partition TTL type: string x-stream-index: "026" permissions: @@ -3731,47 +4174,50 @@ components: type: array x-stream-index: "020" polls: - description: Enables polls + description: Polls title: Polls type: boolean x-stream-index: "014" push_notifications: - description: Enables push notifications + description: Push notifications title: Push notifications type: boolean x-stream-index: "012" reactions: - description: Enables message reactions + description: Reactions title: Reactions type: boolean x-stream-index: "005" read_events: - description: Read events support + description: Read events title: Read events type: boolean x-stream-index: "003" replies: - description: Enables message replies (threads) + description: Replies title: Replies type: boolean x-stream-index: "006" search: - description: Enables message search + description: Search title: Search type: boolean x-stream-index: "007" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "027" typing_events: - description: Typing events support + description: Typing events title: Typing events type: boolean x-stream-index: "002" uploads: - description: Enables file uploads + description: Uploads title: Uploads type: boolean x-stream-index: "009" url_enrichment: - description: Enables URL enrichment + description: URL enrichment title: URL enrichment type: boolean x-stream-index: "010" @@ -3780,6 +4226,7 @@ components: - max_message_length - automod - automod_behavior + title: CreateChannelTypeRequest type: object CreateChannelTypeResponse: nullable: true @@ -3899,6 +4346,9 @@ components: search: type: boolean x-stream-index: 001.001.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.001.028 typing_events: type: boolean x-stream-index: 001.001.002 @@ -3933,6 +4383,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - created_at - updated_at - commands @@ -3941,7 +4392,7 @@ components: - duration type: object CreateCommandRequest: - description: Represents custom chat command + description: Create a new command nullable: true properties: args: @@ -3972,23 +4423,25 @@ components: required: - name - description - title: Command + title: CreateCommandRequest type: object CreateCommandResponse: nullable: true properties: command: $ref: '#/components/schemas/Command' + description: Command object + title: Command x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" required: - duration + title: CreateCommandResponse type: object CreateDeviceRequest: + description: Create device request nullable: true properties: id: @@ -4029,6 +4482,7 @@ components: required: - id - push_provider + title: CreateDeviceRequest type: object CreateExternalStorageRequest: nullable: true @@ -4064,6 +4518,7 @@ components: - bucket type: object CreateExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -4073,6 +4528,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object CreateGuestRequest: nullable: true @@ -4125,6 +4581,7 @@ components: - mode type: object CreateImportResponse: + description: Basic response information nullable: true properties: duration: @@ -4137,6 +4594,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object CreateImportURLRequest: nullable: true @@ -4146,6 +4604,7 @@ components: x-stream-index: "001" type: object CreateImportURLResponse: + description: Basic response information nullable: true properties: duration: @@ -4163,6 +4622,7 @@ components: - path - upload_url - duration + title: Response type: object CreatePollOptionRequest: nullable: true @@ -4273,6 +4733,7 @@ components: - name type: object CreateRoleResponse: + description: Basic response information nullable: true properties: duration: @@ -4286,6 +4747,7 @@ components: required: - duration - role + title: Response type: object CustomActionRequest: properties: @@ -4333,6 +4795,7 @@ components: - entity_creator_id type: object CustomCheckResponse: + description: Basic response information nullable: true properties: duration: @@ -4371,6 +4834,7 @@ components: - report - scored_at - duration + title: Response type: object Data: properties: @@ -4423,6 +4887,7 @@ components: - duration type: object DeactivateUsersRequest: + description: Deactivate users request nullable: true properties: created_by_id: @@ -4449,8 +4914,10 @@ components: x-stream-index: "001" required: - user_ids + title: DeactivateUsersRequest type: object DeactivateUsersResponse: + description: Basic response information nullable: true properties: duration: @@ -4464,6 +4931,7 @@ components: required: - task_id - duration + title: Response type: object DeleteActivityRequest: properties: @@ -4472,6 +4940,7 @@ components: x-stream-index: "001" type: object DeleteCallRequest: + description: DeleteCallRequest is the payload for deleting a call. nullable: true properties: hard: @@ -4480,26 +4949,30 @@ components: 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: - description: Duration of the request in milliseconds - title: 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: @@ -4512,6 +4985,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteChannelsRequest: nullable: true @@ -4570,18 +5044,20 @@ components: nullable: true properties: duration: - description: Duration of the request in milliseconds - title: 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: @@ -4591,6 +5067,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteMessageRequest: properties: @@ -4599,6 +5076,7 @@ components: x-stream-index: "001" type: object DeleteMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -4612,8 +5090,10 @@ components: required: - message - duration + title: Response type: object DeleteModerationConfigResponse: + description: Basic response information nullable: true properties: duration: @@ -4623,8 +5103,10 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteModerationTemplateResponse: + description: Basic response information nullable: true properties: duration: @@ -4634,6 +5116,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object DeleteReactionRequest: properties: @@ -4642,28 +5125,54 @@ components: x-stream-index: "001" 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 + 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" @@ -4767,6 +5276,62 @@ components: - 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: @@ -4815,23 +5380,7 @@ components: - id - created_at - user_id - title: Device - 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 + title: DeviceResponse type: object EdgeResponse: properties: @@ -4927,16 +5476,22 @@ components: - 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 EnrichedActivity: properties: @@ -4984,73 +5539,312 @@ components: x-stream-index: "006" to: items: - type: string + 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: + ban_count: + format: int32 + type: integer + x-stream-index: "002" + ban_expires: + format: date-time + type: number + x-stream-index: "001.016" + banned: + type: boolean + x-stream-index: "001.015" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.007" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.005" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + 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.022" + language: + type: string + x-stream-index: "001.033" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.010" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + online: + readOnly: true + type: boolean + x-stream-index: "001.021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "001.024" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.040" + role: + type: string + x-stream-index: "001.004" + teams: + items: + type: string + type: array + x-stream-index: "001.034" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + required: + - id + - role + - custom + - banned + - online + - ban_count + - deleted_content_count + type: object + EntityCreatorResponse: + description: User response object + properties: + ban_count: + format: int32 + type: integer + x-stream-index: "002" + ban_expires: + description: Date when ban expires + format: date-time + title: Ban expires + type: number + x-stream-index: "001.003" + banned: + description: Whether a user is banned or not + title: Banned + type: boolean + x-stream-index: 001.001.011 + blocked_user_ids: + items: + type: string + type: array + x-stream-index: 001.001.016 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.008 + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: 001.001.004 + deactivated_at: + description: Date of deactivation + format: date-time + title: Deactivated at + type: number + x-stream-index: 001.001.015 + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: 001.001.010 + deleted_content_count: + format: int32 + type: integer + x-stream-index: "003" + devices: + description: List of devices user is using + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices type: array - x-stream-index: "009" - verb: + x-stream-index: "001.006" + id: + description: Unique user identifier + title: ID type: string - x-stream-index: "003" - type: object - EnrichedReaction: - nullable: true - properties: - activity_id: + x-stream-index: 001.001.001 + image: + title: Image 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: + x-stream-index: 001.001.003 + invisible: + type: boolean + x-stream-index: "001.007" + language: + description: Preferred language of a user + title: Language type: string - x-stream-index: "001" - kind: + x-stream-index: 001.001.005 + last_active: + description: Date of last activity + format: date-time + title: Last active + type: number + x-stream-index: 001.001.013 + name: + description: Optional name of user + title: 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: + x-stream-index: 001.001.002 + online: + description: Whether a user online or not + title: Online + type: boolean + x-stream-index: 001.001.012 + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + description: User privacy settings + title: Privacy settings + x-stream-index: "001.005" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettingsResponse' + description: User push notification settings + title: Push notifications + x-stream-index: "001.004" + revoke_tokens_issued_before: + description: Revocation date for tokens + format: date-time + title: Revoke tokens issued before + type: number + x-stream-index: 001.001.014 + role: + description: Determines the set of user permissions + title: Role type: string - x-stream-index: "007" - target_feeds: + x-stream-index: 001.001.006 + shadow_banned: + description: Whether a user is shadow banned + title: Shadow banned + type: boolean + x-stream-index: "001.002" + teams: + description: List of teams user is a part of items: type: string + title: Teams type: array - x-stream-index: "006" + x-stream-index: 001.001.007 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" + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: 001.001.009 required: - - kind - - activity_id - - user_id + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - devices + - invisible + - ban_count + - deleted_content_count + title: UserResponse type: object ErrorResult: properties: @@ -5101,6 +5895,7 @@ components: - type type: object EventResponse: + description: Basic response information nullable: true properties: duration: @@ -5114,6 +5909,7 @@ components: required: - event - duration + title: Response type: object ExportChannelsRequest: nullable: true @@ -5199,17 +5995,23 @@ components: type: string x-stream-index: "004.001" messages: + description: List of exported messages items: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' + title: Messages type: array x-stream-index: "002" reactions: + description: List of exported reactions items: - $ref: '#/components/schemas/Reaction' + $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 @@ -5228,6 +6030,7 @@ components: - user_ids type: object ExportUsersResponse: + description: Basic response information nullable: true properties: duration: @@ -5241,6 +6044,7 @@ components: required: - task_id - duration + title: Response type: object ExternalStorageResponse: properties: @@ -5464,9 +6268,70 @@ components: type: number x-stream-index: "018" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' + x-stream-index: "006" + required: + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object + Flag2Response: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "014" + 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_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "015" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" required: + - user_id - entity_type - entity_id - result @@ -5544,6 +6409,7 @@ components: $ref: '#/components/schemas/ModerationPayload' x-stream-index: "005" reason: + maxLength: 255 type: string x-stream-index: "004" user: @@ -5555,9 +6421,9 @@ components: required: - entity_type - entity_id - - reason type: object FlagResponse: + description: Basic response information nullable: true properties: duration: @@ -5571,6 +6437,7 @@ components: required: - item_id - duration + title: Response type: object FullUserResponse: properties: @@ -5605,7 +6472,7 @@ components: x-stream-index: "001.010" devices: items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' type: array x-stream-index: "004" id: @@ -5798,6 +6665,7 @@ components: - accuracy_radius type: object GetApplicationResponse: + description: Basic response information nullable: true properties: app: @@ -5811,8 +6679,10 @@ components: required: - app - duration + title: Response type: object GetBlockListResponse: + description: Response for get block list nullable: true properties: blocklist: @@ -5825,7 +6695,7 @@ components: x-stream-index: "002.001" required: - duration - title: Get Block list response + title: GetBlockListResponse type: object x-stream-docs-page-id: get_block_list GetBlockedUsersResponse: @@ -5872,8 +6742,10 @@ components: - own_capabilities - blocked_users - duration + title: GetCallResponse type: object GetCallStatsResponse: + description: Basic response information nullable: true properties: aggregated: @@ -5946,6 +6818,7 @@ components: - max_freezes_duration_seconds - sfus - participant_report + title: Response type: object GetCallTypeResponse: nullable: true @@ -5988,8 +6861,26 @@ components: - 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: "002.001" + required: + - duration + title: Response type: object GetChannelTypeResponse: + description: Basic response information nullable: true properties: allowed_flag_reasons: @@ -6045,6 +6936,8 @@ components: 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: @@ -6107,6 +7000,9 @@ components: search: type: boolean x-stream-index: 003.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.028 typing_events: type: boolean x-stream-index: 003.002.002 @@ -6145,8 +7041,10 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - commands - duration + title: Response type: object GetCommandResponse: nullable: true @@ -6182,8 +7080,10 @@ components: - args - set - duration + title: GetCommandResponse type: object GetConfigResponse: + description: Basic response information nullable: true properties: config: @@ -6196,8 +7096,10 @@ components: x-stream-index: "002.001" required: - duration + title: Response type: object GetCustomPermissionResponse: + description: Basic response information nullable: true properties: duration: @@ -6211,8 +7113,10 @@ components: required: - permission - duration + title: Response type: object GetEdgesResponse: + description: Basic response information nullable: true properties: duration: @@ -6228,6 +7132,7 @@ components: required: - edges - duration + title: Response type: object GetExportChannelsStatusResponse: nullable: true @@ -6283,6 +7188,7 @@ components: - duration type: object GetImportResponse: + description: Basic response information nullable: true properties: duration: @@ -6295,6 +7201,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object GetManyMessagesResponse: nullable: true @@ -6305,7 +7212,7 @@ components: messages: description: List of messages items: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' title: Messages type: array x-stream-index: "001.001" @@ -6314,6 +7221,7 @@ components: - duration type: object GetMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -6332,6 +7240,7 @@ components: required: - message - duration + title: Response type: object GetOGResponse: nullable: true @@ -6365,7 +7274,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "001.018" + x-stream-index: "001.021" duration: type: string x-stream-index: "002.001" @@ -6385,28 +7294,39 @@ components: x-stream-index: "001.014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "001.019" + x-stream-index: "001.022" image_url: description: URL of detected image title: Image URL type: string x-stream-index: "001.011" + latitude: + format: float + type: number + x-stream-index: "001.018" + longitude: + format: float + type: number + x-stream-index: "001.019" og_scrape_url: description: extracted url from the text title: OG Scrape URL type: string - x-stream-index: "001.020" + x-stream-index: "001.023" original_height: format: int32 type: integer - x-stream-index: "001.022" + x-stream-index: "001.025" original_width: format: int32 type: integer - x-stream-index: "001.021" + x-stream-index: "001.024" pretext: type: string x-stream-index: "001.004" + stopped_sharing: + type: boolean + x-stream-index: "001.020" text: description: og:description title: Text @@ -6464,6 +7384,7 @@ components: video: type: boolean x-stream-index: "006" + title: GetOrCreateCallRequest type: object GetOrCreateCallResponse: nullable: true @@ -6494,6 +7415,7 @@ components: - blocked_users - created - duration + title: GetOrCreateCallResponse type: object GetRateLimitsResponse: nullable: true @@ -6568,6 +7490,7 @@ components: - duration type: object GetRepliesResponse: + description: Basic response information nullable: true properties: duration: @@ -6583,8 +7506,10 @@ components: required: - messages - duration + title: Response type: object GetReviewQueueItemResponse: + description: Basic response information nullable: true properties: duration: @@ -6594,15 +7519,32 @@ components: x-stream-index: "003.001" history: items: - $ref: '#/components/schemas/ReviewQueueItem' + $ref: '#/components/schemas/ReviewQueueItemResponse' type: array x-stream-index: "002" item: - $ref: '#/components/schemas/ReviewQueueItem' + $ref: '#/components/schemas/ReviewQueueItemResponse' x-stream-index: "001" required: - history - 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 @@ -6664,6 +7606,7 @@ components: - duration type: object GetUserModerationReportResponse: + description: Basic response information nullable: true properties: duration: @@ -6689,6 +7632,7 @@ components: - user_mutes - user_blocks - duration + title: Response type: object GoLiveRequest: nullable: true @@ -6711,8 +7655,10 @@ components: transcription_storage_name: type: string x-stream-index: "006" + title: GoLiveRequest type: object GoLiveResponse: + description: Basic response information nullable: true properties: call: @@ -6726,6 +7672,7 @@ components: required: - call - duration + title: Response type: object GoogleVisionConfig: properties: @@ -6777,13 +7724,17 @@ components: 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: @@ -6793,6 +7744,7 @@ components: quality_tracks: items: type: string + title: Quality Tracks type: array x-stream-index: "003" required: @@ -6800,6 +7752,7 @@ components: - enabled - quality_tracks - layout + title: HLSSettingsResponse type: object HideChannelRequest: nullable: true @@ -6817,6 +7770,7 @@ components: x-stream-index: "003.001" type: object HideChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -6826,6 +7780,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object HuaweiConfig: properties: @@ -7068,15 +8023,19 @@ components: 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 @@ -7218,6 +8177,7 @@ components: x-stream-index: "001" type: object ListBlockListResponse: + description: Basic response information nullable: true properties: blocklists: @@ -7233,8 +8193,10 @@ components: required: - blocklists - duration + title: Response type: object ListCallTypeResponse: + description: Response for ListCallType nullable: true properties: call_types: @@ -7248,6 +8210,7 @@ components: required: - call_types - duration + title: ListCallTypeResponse type: object ListChannelTypesResponse: nullable: true @@ -7269,31 +8232,34 @@ components: 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: - description: Duration of the request in milliseconds - title: 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/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "001" @@ -7303,8 +8269,10 @@ components: required: - devices - duration + title: ListDevicesResponse type: object ListExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -7320,8 +8288,10 @@ components: required: - duration - external_storages + title: Response type: object ListImportsResponse: + description: Basic response information nullable: true properties: duration: @@ -7337,8 +8307,10 @@ components: required: - import_tasks - duration + title: Response type: object ListPermissionsResponse: + description: Basic response information nullable: true properties: duration: @@ -7354,8 +8326,10 @@ components: required: - permissions - duration + title: Response type: object ListPushProvidersResponse: + description: Basic response information nullable: true properties: duration: @@ -7371,8 +8345,10 @@ components: required: - push_providers - duration + title: Response type: object ListRecordingsResponse: + description: Response for listing recordings nullable: true properties: duration: @@ -7381,13 +8357,16 @@ components: 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: @@ -7403,6 +8382,7 @@ components: required: - roles - duration + title: Response type: object ListTranscriptionsResponse: nullable: true @@ -7411,13 +8391,16 @@ components: 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 Location: properties: @@ -7489,6 +8472,17 @@ components: 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: @@ -7530,6 +8524,7 @@ components: - video_subscribed type: object MemberRequest: + description: MemberRequest is the payload for adding a member to a call. properties: custom: additionalProperties: {} @@ -7548,8 +8543,10 @@ components: 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 @@ -7591,6 +8588,7 @@ components: - custom - created_at - updated_at + title: MemberResponse type: object MembersResponse: nullable: true @@ -7612,39 +8610,23 @@ components: - duration type: object Message: - description: Represents any chat message - nullable: true 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: "011" before_message_send_failed: - description: Whether `before_message_send webhook` failed or not. Field - is only accessible in push webhook - title: Before Message Send Failed type: boolean - x-stream-docs-page-id: before_message_send_webhook x-stream-index: "045" cid: - description: Channel unique identifier in : format - title: Channel CID type: string x-stream-index: "027" command: - description: Contains provided slash command - title: Command type: string - x-stream-docs-page-id: custom_commands_webhook x-stream-index: "006" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "029" custom: @@ -7652,9 +8634,7 @@ components: type: object x-stream-index: "033" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: number x-stream-index: "032" deleted_reply_count: @@ -7662,23 +8642,14 @@ components: type: integer x-stream-index: "022" 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: "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: "043" id: - description: Message ID is unique string identifier of the message - title: ID type: string x-stream-index: "002" image_labels: @@ -7686,22 +8657,16 @@ components: items: type: string type: array - description: Contains image moderation information - title: Image moderation labels type: object x-stream-index: "039" latest_reactions: - description: List of 10 latest reactions to this message items: $ref: '#/components/schemas/Reaction' - title: Latest reactions type: array x-stream-index: "012" mentioned_users: - description: List of mentioned users items: - $ref: '#/components/schemas/UserObject' - title: Mentioned Users + $ref: '#/components/schemas/User' type: array x-stream-index: "042" message_text_updated_at: @@ -7709,77 +8674,46 @@ components: type: number x-stream-index: "051" 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: "005" own_reactions: - description: List of 10 latest reactions of authenticated user to this message items: $ref: '#/components/schemas/Reaction' - title: Own reactions type: array x-stream-index: "013" parent_id: - description: ID of parent message (thread) - title: Parent message ID type: string - x-stream-docs-page-id: threads x-stream-index: "018" 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: "050" pinned: - description: Whether message is pinned or not - title: Pinned type: boolean - x-stream-docs-page-id: pinned_messages x-stream-index: "046" 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: "047" pinned_by: - $ref: '#/components/schemas/UserObject' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages + $ref: '#/components/schemas/User' x-stream-index: "049" poll: $ref: '#/components/schemas/Poll' x-stream-index: "053" poll_id: - description: Identifier of the poll to include in the message - title: Poll ID type: string x-stream-index: "052" quoted_message: $ref: '#/components/schemas/Message' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message x-stream-index: "024" quoted_message_id: - title: ID of quoted message type: string - x-stream-docs-page-id: threads#quote-message x-stream-index: "023" 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: "014" reaction_groups: @@ -7791,70 +8725,38 @@ components: 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: "015" reply_count: - description: Number of replies to this message format: int32 - title: Reply count type: integer x-stream-index: "021" shadowed: - description: Whether the message was shadowed or not - title: Shadowed type: boolean - x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "035" 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: "020" silent: - description: Whether message is silent or not - title: Silent type: boolean x-stream-index: "044" text: - description: Text of the message. Should be empty if `mml` is provided - title: Text type: string x-stream-index: "004" thread_participants: - description: List of users who participate in thread items: - $ref: '#/components/schemas/UserObject' - title: Thread participants + $ref: '#/components/schemas/User' type: array - x-stream-docs-page-id: threads#quote-message x-stream-index: "026" 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: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number x-stream-index: "030" user: - $ref: '#/components/schemas/UserObject' - description: Sender of the message. Required when using server-side API - title: User object + $ref: '#/components/schemas/User' x-stream-index: "010" required: - id @@ -7877,9 +8779,7 @@ components: - mentioned_users - silent - pinned - title: Message type: object - x-stream-docs-page-id: send_message MessageActionRequest: nullable: true properties: @@ -8044,7 +8944,7 @@ components: ai_moderation_response: $ref: '#/components/schemas/ModerationResponse' description: Response from AI moderation - title: AI moderation response + title: ModerationResponse x-stream-index: "007" blocked_word: description: Word that was blocked @@ -8075,7 +8975,7 @@ components: moderation_thresholds: $ref: '#/components/schemas/Thresholds' description: Thresholds for AI moderation - title: Moderation thresholds + title: Thresholds x-stream-index: "006" updated_at: description: Date/time of the last update @@ -8109,43 +9009,39 @@ components: properties: channel_id: type: string - x-stream-index: "002.002" + x-stream-index: "003" channel_type: type: string - x-stream-index: "002.003" + x-stream-index: "004" cid: type: string - x-stream-index: "002.001" + x-stream-index: "002" created_at: format: date-time type: number - x-stream-index: "005.002" + x-stream-index: "008" last_read_message_id: type: string - x-stream-index: "006" + x-stream-index: "009" team: type: string - x-stream-index: "004.001" + x-stream-index: "006" thread: $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "003.001" + x-stream-index: "005" type: type: string - x-stream-index: "005.001" + x-stream-index: "007" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "001.001" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" required: - cid - channel_id - channel_type - type - created_at - title: MessageReadEvent type: object - x-stream-event-client-type: true - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent MessageRequest: properties: attachments: @@ -8218,20 +9114,31 @@ components: x-stream-index: "020.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: "021" 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: "022" custom: @@ -8239,7 +9146,9 @@ components: type: object x-stream-index: "025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: number x-stream-index: "024" deleted_reply_count: @@ -8247,14 +9156,23 @@ components: type: integer x-stream-index: "017" 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: "029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001" image_labels: @@ -8262,16 +9180,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "027" 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: "028" message_text_updated_at: @@ -8279,46 +9203,77 @@ components: type: number x-stream-index: "035" 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" 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: "014" 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: "034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "031" 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: "032" 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: "033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "036" quoted_message: $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message x-stream-index: "019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "018" 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: @@ -8330,38 +9285,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "016" shadowed: + description: Whether the message was shadowed or not + title: Shadowed type: boolean + x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "026" 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: "015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "030" 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: "020" 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: "023" 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 @@ -8384,7 +9371,9 @@ components: - mentioned_users - silent - pinned + title: Message type: object + x-stream-docs-page-id: send_message MessageUpdate: properties: change_set: @@ -8395,23 +9384,36 @@ components: x-stream-index: "001" type: object 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.021" 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.022" custom: @@ -8419,7 +9421,9 @@ components: type: object x-stream-index: "001.025" deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: number x-stream-index: "001.024" deleted_reply_count: @@ -8427,14 +9431,23 @@ components: type: integer x-stream-index: "001.017" 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.029" id: + description: Message ID is unique string identifier of the message + title: ID type: string x-stream-index: "001.001" image_labels: @@ -8442,16 +9455,22 @@ components: items: type: string type: array + description: Contains image moderation information + title: Image moderation labels type: object x-stream-index: "001.027" 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.028" message_text_updated_at: @@ -8459,46 +9478,77 @@ components: type: number x-stream-index: "001.035" 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" 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.014" 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.034" pinned: + description: Whether message is pinned or not + title: Pinned type: boolean + x-stream-docs-page-id: pinned_messages x-stream-index: "001.031" 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.032" 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.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string x-stream-index: "001.036" 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.019" quoted_message_id: + title: ID of quoted message type: string + x-stream-docs-page-id: threads#quote-message x-stream-index: "001.018" 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: @@ -8510,38 +9560,70 @@ components: 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" reply_count: + description: Number of replies to this message format: int32 + title: Reply count type: integer x-stream-index: "001.016" 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.026" 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.015" silent: + description: Whether message is silent or not + title: Silent type: boolean x-stream-index: "001.030" 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.020" 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.023" 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 @@ -8565,7 +9647,9 @@ components: - silent - pinned - channel + title: Message type: object + x-stream-docs-page-id: send_message ModerationActionConfig: nullable: true properties: @@ -8597,53 +9681,6 @@ components: - description - custom type: object - ModerationConfig: - nullable: true - properties: - async: - type: boolean - x-stream-index: "005" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - x-stream-index: "007" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - x-stream-index: "008" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - x-stream-index: "006" - aws_rekognition_config: - $ref: '#/components/schemas/AWSRekognitionConfig' - x-stream-index: "011" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - x-stream-index: "009" - bodyguard_config: - $ref: '#/components/schemas/BodyguardConfig' - x-stream-index: "010" - created_at: - format: date-time - type: number - x-stream-index: "014" - google_vision_config: - $ref: '#/components/schemas/GoogleVisionConfig' - x-stream-index: "012" - key: - type: string - x-stream-index: "004" - updated_at: - format: date-time - type: number - x-stream-index: "015" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - x-stream-index: "013" - required: - - key - - async - - created_at - - updated_at - type: object ModerationPayload: properties: custom: @@ -8693,25 +9730,41 @@ components: ModerationUsageStats: nullable: true properties: - bucket: - type: string + app_pk: + format: int32 + type: integer + x-stream-index: "004" + id: + format: int32 + type: integer x-stream-index: "003" - metric: - type: string + organization_id: + format: int32 + type: integer + x-stream-index: "005" + reference_date: + format: date-time + type: number x-stream-index: "006" updated_at: format: date-time type: number - x-stream-index: "005" - value: + x-stream-index: "009" + usage_amount: format: int32 type: integer + x-stream-index: "008" + usage_type: + type: string x-stream-index: "007" required: - - bucket + - id + - app_pk + - organization_id + - reference_date + - usage_type + - usage_amount - updated_at - - metric - - value type: object ModeratorStats: nullable: true @@ -8735,6 +9788,7 @@ components: - action_counts type: object ModeratorStatsResponse: + description: Basic response information nullable: true properties: duration: @@ -8750,6 +9804,7 @@ components: required: - moderator_stats - duration + title: Response type: object MuteChannelRequest: nullable: true @@ -8824,6 +9879,7 @@ components: x-stream-index: "003.001" required: - target_ids + title: MuteRequest type: object MuteResponse: nullable: true @@ -8853,6 +9909,7 @@ components: x-stream-index: "002" required: - duration + title: MuteResponse type: object MuteUsersRequest: nullable: true @@ -8888,8 +9945,10 @@ components: 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: @@ -8899,6 +9958,7 @@ components: x-stream-index: "001.001" required: - duration + title: MuteUsersResponse type: object NoiseCancellationSettings: properties: @@ -8991,9 +10051,11 @@ components: - send-audio - send-video - start-broadcast-call + - start-closed-captions-call - start-record-call - start-transcription-call - stop-broadcast-call + - stop-closed-captions-call - stop-record-call - stop-transcription-call - update-call @@ -9006,17 +10068,17 @@ components: properties: banned: type: boolean - x-stream-index: "014" + x-stream-index: "015" blocked_user_ids: items: type: string type: array - x-stream-index: "042" + x-stream-index: "043" channel_mutes: items: $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "027" + x-stream-index: "028" created_at: format: date-time type: number @@ -9028,92 +10090,222 @@ components: deactivated_at: format: date-time type: number - x-stream-index: "012" + x-stream-index: "013" deleted_at: format: date-time type: number - x-stream-index: "011" + x-stream-index: "012" devices: items: $ref: '#/components/schemas/Device' type: array + x-stream-index: "026" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "022" + language: + type: string + x-stream-index: "033" + last_active: + format: date-time + type: number + x-stream-index: "010" + last_engaged_at: + format: date-time + type: number + x-stream-index: "011" + latest_hidden_channels: + items: + type: string + type: array + x-stream-index: "035" + mutes: + items: + $ref: '#/components/schemas/UserMute' + type: array + x-stream-index: "027" + online: + type: boolean + x-stream-index: "021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' x-stream-index: "025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "024" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "034" + total_unread_count: + format: int32 + type: integer + x-stream-index: "030" + unread_channels: + format: int32 + type: integer + x-stream-index: "031" + unread_count: + format: int32 + type: integer + x-stream-index: "029" + unread_threads: + format: int32 + type: integer + x-stream-index: "032" + updated_at: + format: date-time + type: number + x-stream-index: "008" + required: + - id + - role + - custom + - created_at + - updated_at + - banned + - online + - devices + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + - language + type: object + OwnUserResponse: + properties: + banned: + type: boolean + x-stream-index: "001.011" + 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.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.015" + deleted_at: + format: date-time + type: number + x-stream-index: "001.010" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array + x-stream-index: "004" id: type: string - x-stream-index: "003" + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" invisible: type: boolean - x-stream-index: "021" + x-stream-index: "005" language: type: string - x-stream-index: "032" + x-stream-index: "001.005" last_active: format: date-time type: number - x-stream-index: "010" + x-stream-index: "001.013" latest_hidden_channels: items: type: string type: array - x-stream-index: "034" + x-stream-index: "012" mutes: items: - $ref: '#/components/schemas/UserMute' + $ref: '#/components/schemas/UserMuteResponse' type: array - x-stream-index: "026" + x-stream-index: "006" + name: + type: string + x-stream-index: "001.002" online: type: boolean - x-stream-index: "020" + x-stream-index: "001.012" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" push_notifications: - $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" + $ref: '#/components/schemas/PushNotificationSettingsResponse' + x-stream-index: "002" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.014" role: type: string - x-stream-index: "004" + x-stream-index: "001.006" teams: items: type: string type: array - x-stream-index: "033" + x-stream-index: "001.007" total_unread_count: format: int32 type: integer - x-stream-index: "029" + x-stream-index: "009" unread_channels: format: int32 type: integer - x-stream-index: "030" + x-stream-index: "010" unread_count: format: int32 type: integer - x-stream-index: "028" + x-stream-index: "008" unread_threads: format: int32 type: integer - x-stream-index: "031" + x-stream-index: "011" updated_at: format: date-time type: number - x-stream-index: "008" + x-stream-index: "001.009" required: - id - - role - custom + - language + - role + - teams - created_at - updated_at - banned - online - devices + - invisible - mutes - channel_mutes - unread_count - total_unread_count - unread_channels - unread_threads - - language type: object PaginationParams: properties: @@ -9217,6 +10409,7 @@ components: - tags type: object PinRequest: + description: PinRequest is the payload for pinning a message. nullable: true properties: session_id: @@ -9232,8 +10425,10 @@ components: required: - user_id - session_id + title: PinRequest type: object PinResponse: + description: Basic response information nullable: true properties: duration: @@ -9243,6 +10438,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Policy: properties: @@ -9288,6 +10484,7 @@ components: - updated_at type: object PolicyRequest: + description: Policy request properties: action: enum: @@ -9336,6 +10533,7 @@ components: - roles - owner - priority + title: PolicyRequest type: object Poll: properties: @@ -9359,7 +10557,7 @@ components: type: number x-stream-index: "021" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "020" created_by_id: type: string @@ -9546,7 +10744,7 @@ components: additionalProperties: {} type: object writeOnly: true - x-stream-index: "020" + x-stream-index: "021" allow_answers: type: boolean x-stream-index: "008" @@ -9560,13 +10758,13 @@ components: created_at: format: date-time type: number - x-stream-index: "018" + x-stream-index: "019" created_by: $ref: '#/components/schemas/UserResponse' - x-stream-index: "017" + x-stream-index: "018" created_by_id: type: string - x-stream-index: "016" + x-stream-index: "017" description: type: string x-stream-index: "003" @@ -9579,6 +10777,11 @@ components: 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: @@ -9602,11 +10805,11 @@ components: items: $ref: '#/components/schemas/PollVoteResponseData' type: array - x-stream-index: "015" + x-stream-index: "016" updated_at: format: date-time type: number - x-stream-index: "019" + x-stream-index: "020" vote_count: format: int32 type: integer @@ -9633,6 +10836,7 @@ components: - answers_count - vote_counts_by_option - latest_votes_by_option + - latest_answers - own_votes - created_by_id - created_at @@ -9666,7 +10870,7 @@ components: type: number x-stream-index: "011" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "009" user_id: type: string @@ -10164,6 +11368,7 @@ components: - id type: object QueryCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -10185,6 +11390,7 @@ components: required: - members - duration + title: Response type: object QueryCallStatsRequest: nullable: true @@ -10213,6 +11419,7 @@ components: x-stream-index: "002" type: object QueryCallStatsResponse: + description: Basic response information nullable: true properties: duration: @@ -10234,12 +11441,14 @@ components: required: - reports - duration + title: Response type: object QueryCallsRequest: nullable: true properties: filter_conditions: additionalProperties: {} + title: Filters type: object x-stream-index: "003" limit: @@ -10255,11 +11464,14 @@ components: 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 @@ -10284,6 +11496,57 @@ components: 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: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + type: array + x-stream-index: "002" + 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 @@ -10383,6 +11646,7 @@ components: - updated_at type: object QueryFeedModerationTemplatesResponse: + description: Basic response information nullable: true properties: duration: @@ -10398,8 +11662,10 @@ components: required: - templates - duration + title: Response type: object QueryMembersPayload: + description: Client request properties: filter_conditions: additionalProperties: {} @@ -10444,6 +11710,7 @@ components: required: - type - filter_conditions + title: ClientRequest type: object QueryMessageFlagsPayload: properties: @@ -10469,7 +11736,7 @@ components: x-stream-index: "002" sort: items: - $ref: '#/components/schemas/SortParam' + $ref: '#/components/schemas/SortParamRequest' maximum: 5 type: array x-stream-index: "003.005" @@ -10481,6 +11748,7 @@ components: x-stream-index: "004.001" type: object QueryMessageFlagsResponse: + description: Query message flags response nullable: true properties: duration: @@ -10498,6 +11766,7 @@ components: required: - flags - duration + title: QueryMessageFlagsResponse type: object QueryMessageHistoryRequest: nullable: true @@ -10590,11 +11859,12 @@ components: x-stream-index: "004.001" type: object QueryModerationConfigsResponse: + description: Basic response information nullable: true properties: configs: items: - $ref: '#/components/schemas/ModerationConfig' + $ref: '#/components/schemas/ConfigResponse' type: array x-stream-index: "001" duration: @@ -10611,6 +11881,7 @@ components: required: - configs - duration + title: Response type: object QueryModerationLogsRequest: nullable: true @@ -10644,6 +11915,7 @@ components: x-stream-index: "004.001" type: object QueryModerationLogsResponse: + description: Basic response information nullable: true properties: duration: @@ -10665,6 +11937,7 @@ components: required: - logs - duration + title: Response type: object QueryPollVotesRequest: nullable: true @@ -10759,56 +12032,204 @@ components: x-stream-index: "002" limit: format: int32 - maximum: 100 + 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 + QueryReviewQueueRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "007.001" + lock_count: + format: int32 + maximum: 25 + minimum: 1 + type: integer + x-stream-index: "005" + lock_duration: + type: integer + x-stream-index: "004" + 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: + items: + $ref: '#/components/schemas/SortParamRequest' + type: array + x-stream-index: "002" + 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: + description: Basic response information + nullable: true + properties: + action_config: + additionalProperties: + items: + $ref: '#/components/schemas/ModerationActionConfig' + type: array + type: object + x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "005.001" + items: + items: + $ref: '#/components/schemas/ReviewQueueItemResponse' + type: array + x-stream-index: "001" + next: + type: string + x-stream-index: "004.001" + prev: + type: string + x-stream-index: "004.002" + stats: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "003" + required: + - items + - action_config + - stats + - duration + title: Response + 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: "006.001" + x-stream-index: "002" next: + description: Next + title: string 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: + prev: + description: Prev + title: string type: string - x-stream-index: "004.001" + x-stream-index: "004" type: object - QueryReactionsResponse: + QuerySegmentTargetsResponse: + 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" next: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" prev: type: string - x-stream-index: "003.002" - reactions: + x-stream-index: "002.002" + targets: + description: Targets items: - $ref: '#/components/schemas/ReactionResponse' + $ref: '#/components/schemas/SegmentTargetResponse' + title: SegmentTargetResponseList type: array x-stream-index: "001" required: - - reactions + - targets - duration type: object - QueryReviewQueueRequest: + QuerySegmentsRequest: nullable: true properties: filter: additionalProperties: {} + description: Filter to apply to the query + title: Filter type: object x-stream-index: "001" limit: @@ -10816,70 +12237,46 @@ components: maximum: 100 minimum: 0 type: integer - x-stream-index: "006.001" - lock_moderator_duration: - type: integer - x-stream-index: "004" - lock_moderator_id: - type: string - x-stream-index: "003" + x-stream-index: "003.001" next: type: string - x-stream-index: "006.002" + x-stream-index: "003.002" prev: type: string - x-stream-index: "006.003" + x-stream-index: "003.003" sort: + description: Array of sort parameters items: $ref: '#/components/schemas/SortParamRequest' + title: Sort type: array x-stream-index: "002" - stats_only: - type: boolean - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "007.002" - user_id: - type: string - x-stream-index: "007.001" + required: + - filter type: object - QueryReviewQueueResponse: + QuerySegmentsResponse: nullable: true properties: - action_config: - additionalProperties: - items: - $ref: '#/components/schemas/ModerationActionConfig' - type: array - type: object - x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "005.001" - items: - items: - $ref: '#/components/schemas/ReviewQueueItem' - type: array - x-stream-index: "001" + x-stream-index: "003.001" next: type: string - x-stream-index: "004.001" + x-stream-index: "002.001" prev: type: string - x-stream-index: "004.002" - stats: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "003" + x-stream-index: "002.002" + segments: + description: Segments + items: + $ref: '#/components/schemas/SegmentResponse' + title: SegmentResponses + type: array + x-stream-index: "001" required: - - items - - action_config - - stats + - segments - duration type: object QueryThreadsRequest: @@ -10983,6 +12380,7 @@ components: x-stream-index: "004.001" type: object QueryUsageStatsResponse: + description: Basic response information nullable: true properties: duration: @@ -11004,6 +12402,7 @@ components: required: - items - duration + title: Response type: object QueryUsersPayload: properties: @@ -11063,6 +12462,7 @@ components: - duration type: object QueueStatsResponse: + description: Basic response information nullable: true properties: avg_time_to_action: @@ -11083,8 +12483,10 @@ components: - avg_time_to_action - time_to_action_buckets - duration + title: Response type: object RTMPBroadcastRequest: + description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. properties: layout: $ref: '#/components/schemas/LayoutSettingsRequest' @@ -11127,16 +12529,18 @@ components: 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: RTMP Ingress + title: RTMPIngress type: object RTMPLocation: properties: @@ -11197,10 +12601,13 @@ components: 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: @@ -11208,22 +12615,21 @@ components: title: Layout x-stream-index: "003" quality: + title: Quality type: string x-stream-index: "002" required: - enabled - quality - layout + title: RTMPSettingsResponse type: object Reaction: - description: Represents user reaction to a message nullable: true properties: created_at: - description: Date/time of creation format: date-time readOnly: true - title: Created at type: number x-stream-index: "008" custom: @@ -11231,35 +12637,25 @@ components: type: object x-stream-index: "010" message_id: - description: ID of a message user reacted to - title: Message ID type: string x-stream-index: "003" score: - description: Reaction score. If not specified reaction has score of 1 format: int32 - title: Score type: integer x-stream-index: "007" type: - description: The type of reaction (e.g. 'like', 'laugh', 'wow') maxLength: 30 - title: Type type: string x-stream-index: "006" updated_at: - description: Date/time of the last update format: date-time readOnly: true - title: Updated at type: number x-stream-index: "009" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005" user_id: - description: ID of a user who reacted to a message - title: User ID type: string x-stream-index: "004" required: @@ -11269,26 +12665,40 @@ components: - created_at - updated_at - custom - title: Reaction type: object - x-stream-docs-page-id: send_reaction 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: @@ -11296,8 +12706,10 @@ components: - sum_scores - first_reaction_at - last_reaction_at + title: ReactionGroupResponse type: object ReactionRemovalResponse: + description: Basic response information nullable: true properties: duration: @@ -11313,11 +12725,15 @@ components: x-stream-index: "002" required: - duration + title: Response type: object 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: @@ -11325,15 +12741,21 @@ components: 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: @@ -11344,7 +12766,9 @@ components: x-stream-index: "006.001" required: - type + title: Reaction type: object + x-stream-docs-page-id: send_reaction ReactionResponse: properties: created_at: @@ -11437,6 +12861,7 @@ components: - duration type: object ReactivateUsersRequest: + description: Reactivate users in batches nullable: true properties: created_by_id: @@ -11463,8 +12888,10 @@ components: x-stream-index: "001" required: - user_ids + title: ReactivateUsersRequest type: object ReactivateUsersResponse: + description: Basic response information nullable: true properties: duration: @@ -11478,41 +12905,21 @@ components: required: - task_id - duration - type: object - Read: - nullable: true - 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/UserObject' - x-stream-index: "001" - required: - - last_read - - unread_messages + 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: @@ -11550,9 +12957,7 @@ components: type: string x-stream-index: "003" required: - - audio_only - mode - - quality type: object RecordSettingsRequest: properties: @@ -11568,6 +12973,7 @@ components: - available - disabled - auto-on + title: Mode type: string x-stream-index: "002" quality: @@ -11586,10 +12992,13 @@ components: 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: @@ -11597,9 +13006,11 @@ components: 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: @@ -11607,8 +13018,10 @@ components: - mode - quality - layout + title: RecordSettingsResponse type: object Response: + description: Basic response information nullable: true properties: duration: @@ -11618,6 +13031,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object RestoreActionRequest: type: object @@ -11640,112 +13054,215 @@ components: items: $ref: '#/components/schemas/ActionLog' type: array + x-stream-index: "028" + assigned_to: + $ref: '#/components/schemas/User' + x-stream-index: "025" + bans: + items: + $ref: '#/components/schemas/Ban' + type: array + x-stream-index: "026" + completed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "017" + content_changed: + type: boolean + x-stream-index: "029" + created_at: + format: date-time + type: number + x-stream-index: "004" + entity_creator: + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "024" + 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: "030" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "031" + flags: + items: + $ref: '#/components/schemas/Flag2' + type: array x-stream-index: "027" + has_image: + type: boolean + x-stream-index: "011" + has_text: + type: boolean + x-stream-index: "013" + has_video: + type: boolean + x-stream-index: "012" + id: + type: string + x-stream-index: "003" + languages: + items: + type: string + type: array + x-stream-index: "018" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "023" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "009" + moderation_payload_hash: + type: string + x-stream-index: "010" + recommended_action: + type: string + x-stream-index: "016" + reviewed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "020" + reviewed_by: + type: string + x-stream-index: "021" + severity: + format: int32 + type: integer + x-stream-index: "019" + status: + type: string + x-stream-index: "015" + teams: + items: + type: string + type: array + x-stream-index: "014" + updated_at: + format: date-time + type: number + x-stream-index: "005" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - moderation_payload_hash + - has_image + - has_video + - has_text + - teams + - status + - recommended_action + - completed_at + - languages + - severity + - reviewed_at + - reviewed_by + - bans + - flags + - actions + - content_changed + type: object + ReviewQueueItemResponse: + nullable: true + properties: + actions: + items: + $ref: '#/components/schemas/ActionLogResponse' + type: array + x-stream-index: "020" assigned_to: - $ref: '#/components/schemas/UserObject' - x-stream-index: "024" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "017" bans: items: $ref: '#/components/schemas/Ban' type: array - x-stream-index: "025" + x-stream-index: "018" completed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "016" - content_changed: - type: boolean - x-stream-index: "028" + format: date-time + type: number + x-stream-index: "009" created_at: format: date-time type: number - x-stream-index: "004" + x-stream-index: "002" entity_creator: - $ref: '#/components/schemas/UserObject' - x-stream-index: "023" + $ref: '#/components/schemas/EntityCreatorResponse' + x-stream-index: "015" + entity_creator_id: + type: string + x-stream-index: "016" entity_id: type: string - x-stream-index: "007" + x-stream-index: "005" entity_type: type: string - x-stream-index: "006" + x-stream-index: "004" feeds_v2_activity: $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "029" + x-stream-index: "021" feeds_v2_reaction: $ref: '#/components/schemas/Reaction' - x-stream-index: "030" + x-stream-index: "022" flags: items: - $ref: '#/components/schemas/Flag2' + $ref: '#/components/schemas/Flag2Response' type: array - x-stream-index: "026" - has_image: - type: boolean - x-stream-index: "011" - has_text: - type: boolean - x-stream-index: "013" - has_video: - type: boolean - x-stream-index: "012" + x-stream-index: "019" id: type: string - x-stream-index: "003" + x-stream-index: "001" languages: items: type: string type: array - x-stream-index: "017" + x-stream-index: "012" message: - $ref: '#/components/schemas/Message' - x-stream-index: "022" + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "014" moderation_payload: $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "009" - moderation_payload_hash: - type: string - x-stream-index: "010" + x-stream-index: "006" recommended_action: type: string - x-stream-index: "015" + x-stream-index: "008" reviewed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "019" + format: date-time + type: number + x-stream-index: "010" reviewed_by: type: string - x-stream-index: "020" + x-stream-index: "011" severity: format: int32 type: integer - x-stream-index: "018" + x-stream-index: "013" status: type: string - x-stream-index: "014" + x-stream-index: "007" updated_at: format: date-time type: number - x-stream-index: "005" + x-stream-index: "003" required: - id - created_at - updated_at - entity_type - entity_id - - moderation_payload_hash - - has_image - - has_video - - has_text - status - recommended_action - - completed_at + - reviewed_by - languages - severity - - reviewed_at - - reviewed_by - bans - flags - actions - - content_changed type: object RingSettings: properties: @@ -12108,7 +13625,7 @@ components: $ref: '#/components/schemas/UserResponse' x-stream-index: "001.033" poll: - $ref: '#/components/schemas/Poll' + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.037" poll_id: type: string @@ -12219,7 +13736,138 @@ components: - 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: @@ -12233,15 +13881,19 @@ components: 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 @@ -12325,6 +13977,7 @@ components: - reaction type: object SendReactionResponse: + description: Basic response information nullable: true properties: duration: @@ -12342,6 +13995,7 @@ components: - message - reaction - duration + title: Response type: object SendUserCustomEventRequest: nullable: true @@ -12363,6 +14017,7 @@ components: x-stream-index: "002.001" type: object ShowChannelResponse: + description: Basic response information nullable: true properties: duration: @@ -12372,12 +14027,14 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object - SortParam: + SortParamRequest: nullable: true properties: direction: - description: Direction of sorting, -1 for descending, 1 for ascending + description: Direction of sorting, 1 for Ascending, -1 for Descending, default + is 1 format: int32 title: Direction type: integer @@ -12388,41 +14045,72 @@ components: type: string x-stream-index: "001" type: object - SortParamRequest: + StartCampaignRequest: nullable: true properties: - direction: - description: Direction of sorting, 1 for Ascending, -1 for Descending, default - is 1 - format: int32 - title: Direction - type: integer + scheduled_for: + format: date-time + type: number x-stream-index: "002" - field: - description: Name of field to sort by - title: Field - type: string + 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: "002.001" + required: + - duration + title: Response + type: object + StartClosedCaptionsRequest: + nullable: true + type: object + StartClosedCaptionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration 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: - description: Duration of the request in milliseconds - title: 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: @@ -12436,8 +14124,11 @@ components: 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: @@ -12447,6 +14138,7 @@ components: x-stream-index: "001.001" required: - duration + title: StartRTMPBroadcastsResponse type: object StartRecordingRequest: nullable: true @@ -12454,15 +14146,21 @@ components: 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 @@ -12470,20 +14168,44 @@ components: transcription_external_storage: type: string x-stream-index: "002" + title: StartTranscriptionRequest 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 type: object - StopAllRTMPBroadcastsResponse: + StopClosedCaptionsResponse: + description: Basic response information nullable: true properties: duration: @@ -12493,11 +14215,13 @@ components: 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: @@ -12507,29 +14231,35 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopLiveRequest: nullable: true + 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: - description: Duration of the request in milliseconds - title: 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: @@ -12539,11 +14269,13 @@ components: 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: @@ -12553,11 +14285,13 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopTranscriptionRequest: nullable: true type: object StopTranscriptionResponse: + description: Basic response information nullable: true properties: duration: @@ -12567,6 +14301,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object SubmitActionRequest: nullable: true @@ -12587,10 +14322,10 @@ components: x-stream-index: "002" ban: $ref: '#/components/schemas/BanActionRequest' - x-stream-index: "007" + x-stream-index: "008" custom: $ref: '#/components/schemas/CustomActionRequest' - x-stream-index: "008" + x-stream-index: "009" delete_activity: $ref: '#/components/schemas/DeleteActivityRequest' x-stream-index: "004" @@ -12606,20 +14341,24 @@ components: item_id: type: string x-stream-index: "001" + mark_reviewed: + $ref: '#/components/schemas/MarkReviewedRequest' + x-stream-index: "007" unban: $ref: '#/components/schemas/UnbanActionRequest' - x-stream-index: "009" + x-stream-index: "010" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "012.002" + x-stream-index: "013.002" user_id: type: string - x-stream-index: "012.001" + x-stream-index: "013.001" required: - item_id - action_type type: object SubmitActionResponse: + description: Basic response information nullable: true properties: duration: @@ -12632,6 +14371,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object Subsession: nullable: true @@ -12696,49 +14436,49 @@ components: format: int32 readOnly: true type: integer - x-stream-index: "002" + x-stream-index: "001" channel_cid: type: string - x-stream-index: "003" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "008" + x-stream-index: "007" custom: additionalProperties: {} type: object - x-stream-index: "011" + x-stream-index: "010" last_read_at: format: date-time type: number - x-stream-index: "010" + x-stream-index: "009" last_thread_message_at: format: date-time type: number - x-stream-index: "004" + 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: "009" + x-stream-index: "008" thread_id: description: Thead ID is unique string identifier of the thread title: ID type: string - x-stream-index: "005" + x-stream-index: "004" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: User is the user object title: User - x-stream-index: "007" + x-stream-index: "006" user_id: description: User ID is unique string identifier of the user title: User ID type: string - x-stream-index: "006" + x-stream-index: "005" required: - app_pk - channel_cid @@ -12772,7 +14512,7 @@ components: type: number x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Created By User title: User x-stream-index: "006" @@ -12800,7 +14540,7 @@ components: type: number x-stream-index: "011" parent_message: - $ref: '#/components/schemas/Message' + $ref: '#/components/schemas/MessageResponse' description: Parent Message title: Message x-stream-index: "004" @@ -12849,6 +14589,7 @@ components: - custom type: object ThreadStateResponse: + nullable: true properties: active_participant_count: description: Active Participant Count @@ -12923,7 +14664,7 @@ components: x-stream-index: "001.008" read: items: - $ref: '#/components/schemas/Read' + $ref: '#/components/schemas/ReadStateResponse' type: array x-stream-index: "003" reply_count: @@ -12961,16 +14702,24 @@ components: - latest_replies 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: @@ -13021,7 +14770,11 @@ components: TranscriptionSettings: properties: closed_caption_mode: - title: string + enum: + - available + - disabled + - auto-on + title: Mode type: string x-stream-index: "002" languages: @@ -13033,12 +14786,11 @@ components: type: array x-stream-index: "003" mode: - description: oneof=available disabled auto-on enum: - available - disabled - auto-on - title: string + title: Mode type: string x-stream-index: "001" required: @@ -13049,6 +14801,10 @@ components: TranscriptionSettingsRequest: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -13070,6 +14826,10 @@ components: TranscriptionSettingsResponse: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -13213,14 +14973,14 @@ components: 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 @@ -13235,6 +14995,7 @@ components: x-stream-index: "004" type: object UnbanResponse: + description: Basic response information nullable: true properties: duration: @@ -13244,10 +15005,12 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object UnblockActionRequest: type: object UnblockUserRequest: + description: UnblockUserRequest is the payload for unblocking a user. nullable: true properties: user_id: @@ -13257,8 +15020,10 @@ components: 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: @@ -13268,6 +15033,7 @@ components: x-stream-index: "001.001" required: - duration + title: UnblockUserResponse type: object UnblockUsersRequest: nullable: true @@ -13336,8 +15102,10 @@ components: x-stream-index: "002.001" required: - target_ids + title: UnmuteRequest type: object UnmuteResponse: + description: Basic response information nullable: true properties: duration: @@ -13352,8 +15120,10 @@ components: 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: @@ -13369,8 +15139,10 @@ components: required: - user_id - session_id + title: UnpinRequest type: object UnpinResponse: + description: UnpinResponse is the payload for unpinning a message. nullable: true properties: duration: @@ -13380,6 +15152,7 @@ components: x-stream-index: "001.001" required: - duration + title: UnpinResponse type: object UnreadCountsBatchRequest: nullable: true @@ -13394,6 +15167,7 @@ components: - user_ids type: object UnreadCountsBatchResponse: + description: Basic response information nullable: true properties: counts_by_user: @@ -13409,6 +15183,7 @@ components: required: - counts_by_user - duration + title: Response type: object UnreadCountsChannel: properties: @@ -13688,6 +15463,7 @@ components: type: object x-stream-docs-page-id: update_block_list UpdateCallMembersRequest: + description: Update call members nullable: true properties: remove_members: @@ -13706,8 +15482,10 @@ components: title: Update Members type: array x-stream-index: "004" + title: UpdateCallMembersRequest type: object UpdateCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -13723,8 +15501,10 @@ components: required: - duration - members + title: Response type: object UpdateCallRequest: + description: Request for updating a call nullable: true properties: custom: @@ -13744,9 +15524,10 @@ components: title: Starts At type: number x-stream-index: "005" + title: UpdateCallRequest type: object UpdateCallResponse: - description: Represents a call + description: Response for updating a call nullable: true properties: call: @@ -13771,9 +15552,10 @@ components: - own_capabilities - blocked_users - duration - title: Call + title: UpdateCallResponse type: object UpdateCallTypeRequest: + description: UpdateCallTypeRequest is the payload for updating a call type. nullable: true properties: external_storage: @@ -13792,18 +15574,24 @@ components: 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: @@ -13811,19 +15599,29 @@ components: 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: @@ -13834,6 +15632,7 @@ components: - created_at - updated_at - duration + title: UpdateCallTypeResponse type: object UpdateChannelPartialRequest: nullable: true @@ -13853,6 +15652,7 @@ components: user_id: type: string x-stream-index: "003.001" + title: UpdateChannelPartialRequest type: object UpdateChannelPartialResponse: nullable: true @@ -14115,6 +15915,9 @@ components: search: type: boolean x-stream-index: 009.001.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 009.001.028 typing_events: type: boolean x-stream-index: 009.001.002 @@ -14247,6 +16050,9 @@ components: search: type: boolean x-stream-index: 003.001.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.001.028 typing_events: type: boolean x-stream-index: 003.001.002 @@ -14283,13 +16089,13 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - created_at - updated_at - commands - duration type: object UpdateCommandRequest: - description: Represents custom chat command nullable: true properties: args: @@ -14312,19 +16118,22 @@ components: x-stream-index: "004" required: - description - title: Command + 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: nullable: true @@ -14356,6 +16165,7 @@ components: - bucket type: object UpdateExternalStorageResponse: + description: Basic response information nullable: true properties: bucket: @@ -14385,6 +16195,7 @@ components: - bucket - path - duration + title: Response type: object UpdateMemberPartialRequest: nullable: true @@ -14487,6 +16298,7 @@ components: - message type: object UpdateMessageResponse: + description: Basic response information nullable: true properties: duration: @@ -14505,6 +16317,7 @@ components: required: - message - duration + title: Response type: object UpdatePollOptionRequest: nullable: true @@ -14722,6 +16535,7 @@ components: - user_id type: object UpdateUserPermissionsResponse: + description: Basic response information nullable: true properties: duration: @@ -14731,6 +16545,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object UpdateUsersPartialRequest: nullable: true @@ -14821,6 +16636,7 @@ components: - key type: object UpsertConfigResponse: + description: Basic response information nullable: true properties: config: @@ -14833,6 +16649,7 @@ components: x-stream-index: "002.001" required: - duration + title: Response type: object UpsertModerationTemplateRequest: nullable: true @@ -14848,6 +16665,7 @@ components: - config type: object UpsertModerationTemplateResponse: + description: Basic response information nullable: true properties: config: @@ -14874,6 +16692,7 @@ components: - created_at - updated_at - duration + title: Response type: object UpsertPushProviderRequest: nullable: true @@ -14883,6 +16702,7 @@ components: x-stream-index: "001" type: object UpsertPushProviderResponse: + description: Basic response information nullable: true properties: duration: @@ -14896,6 +16716,88 @@ components: required: - push_provider - duration + title: Response + type: object + User: + properties: + ban_expires: + format: date-time + type: number + x-stream-index: "016" + banned: + type: boolean + x-stream-index: "015" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "007" + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "013" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "012" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "022" + language: + type: string + x-stream-index: "033" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "010" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "011" + online: + readOnly: true + type: boolean + x-stream-index: "021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "024" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "040" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "034" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + required: + - id + - role + - custom + - banned + - online type: object UserBlock: nullable: true @@ -14932,19 +16834,23 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "003" + x-stream-index: "004" + id: + type: string + x-stream-index: "001" image: type: string - x-stream-index: "002" + x-stream-index: "003" name: type: string - x-stream-index: "001" + x-stream-index: "002" roles: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" required: + - id - name - image - custom @@ -14966,7 +16872,7 @@ components: type: number x-stream-index: "008" target: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: User who's muted title: Target x-stream-index: "007" @@ -14977,7 +16883,7 @@ components: type: number x-stream-index: "010" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' description: Owner of channel mute title: User x-stream-index: "005" @@ -15002,119 +16908,16 @@ components: 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 - UserObject: - description: Represents chat user - properties: - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: number - x-stream-index: "015" - banned: - description: Whether a user is banned or not - title: Banned - type: boolean - x-stream-index: "014" - created_at: - description: Date/time of creation - format: date-time - readOnly: true - title: Created at - type: number - x-stream-index: "007" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - deactivated_at: - description: Date of deactivation - format: date-time - readOnly: true - title: Deactivated at - type: number - x-stream-index: "012" - deleted_at: - description: Date/time of deletion - format: date-time - readOnly: true - title: Deleted at - type: number - x-stream-index: "011" - id: - description: Unique user identifier - title: ID - type: string - x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "021" - language: - description: Preferred language of a user - title: Language - type: string - x-stream-index: "032" - last_active: - description: Date of last activity - format: date-time - readOnly: true - title: Last active - type: number - x-stream-index: "010" - online: - description: Whether a user online or not - readOnly: true - title: Online - type: boolean - x-stream-index: "020" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" - push_notifications: - $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" - revoke_tokens_issued_before: - description: Revocation date for tokens - format: date-time - title: Revoke tokens issued before - type: number - x-stream-index: "039" - role: - description: Determines the set of user permissions - title: Role - type: string - x-stream-index: "004" - teams: - description: List of teams user is a part of - items: - type: string - title: Teams - type: array - x-stream-index: "033" - updated_at: - description: Date/time of the last update - format: date-time - readOnly: true - title: Updated at - type: number - x-stream-index: "008" + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" required: - - id - - role - - custom - - banned - - online - title: User object + - created_at + - updated_at type: object UserRequest: + description: User request object properties: custom: additionalProperties: {} @@ -15142,7 +16945,7 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' @@ -15159,8 +16962,10 @@ components: x-stream-index: "009" required: - id + title: UserRequest type: object UserResponse: + description: User response object properties: ban_expires: description: Date when ban expires @@ -15205,7 +17010,7 @@ components: devices: description: List of devices user is using items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "006" @@ -15295,6 +17100,7 @@ components: - shadow_banned - devices - invisible + title: UserResponse type: object UserSessionStats: properties: @@ -15516,21 +17322,28 @@ components: type: object VelocityFilterConfig: properties: + async: + type: boolean + x-stream-index: "001" cascading_actions: type: boolean - x-stream-index: "003" + x-stream-index: "004" enabled: type: boolean - x-stream-index: "001" + x-stream-index: "002" + first_message_only: + type: boolean + x-stream-index: "005" rules: items: $ref: '#/components/schemas/VelocityFilterConfigRule' type: array - x-stream-index: "002" + x-stream-index: "003" required: - enabled - rules - cascading_actions + - first_message_only type: object VelocityFilterConfigRule: properties: @@ -15542,6 +17355,10 @@ components: - ban type: string x-stream-index: "001" + ban_duration: + format: int32 + type: integer + x-stream-index: "002" cascading_action: enum: - flag @@ -15554,33 +17371,49 @@ components: 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" shadow_ban: type: boolean x-stream-index: "003" - timeout: - format: date-time - type: number - x-stream-index: "002" + 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" 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 type: object - VideoQuality: - properties: - resolution: - $ref: '#/components/schemas/VideoResolution' - x-stream-index: "002" - usage_type: - type: string - x-stream-index: "001" - type: object - VideoResolution: + VideoDimension: properties: height: type: integer @@ -15592,6 +17425,15 @@ components: - width - height type: object + VideoQuality: + properties: + resolution: + $ref: '#/components/schemas/VideoDimension' + x-stream-index: "002" + usage_type: + type: string + x-stream-index: "001" + type: object VideoSettings: properties: access_request_enabled: @@ -15673,7 +17515,7 @@ components: VoteData: properties: Option: - $ref: '#/components/schemas/PollOption' + $ref: '#/components/schemas/PollOptionResponseData' x-stream-index: "003" answer_text: type: string @@ -15688,19 +17530,19 @@ components: properties: automoderation: type: boolean - x-stream-index: "022" + x-stream-index: "021" automoderation_scores: $ref: '#/components/schemas/ModerationResponse' - x-stream-index: "023" + x-stream-index: "022" channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "010" + x-stream-index: "009" channel_id: type: string x-stream-index: "004" channel_type: type: string - x-stream-index: "006" + x-stream-index: "005" cid: type: string x-stream-index: "003" @@ -15710,63 +17552,63 @@ components: created_at: format: date-time type: number - x-stream-index: "027" + x-stream-index: "026" created_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "021" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "020" custom: additionalProperties: {} type: object - x-stream-index: "026" + x-stream-index: "025" me: - $ref: '#/components/schemas/OwnUser' - x-stream-index: "018" + $ref: '#/components/schemas/OwnUserResponse' + x-stream-index: "017" member: $ref: '#/components/schemas/ChannelMember' - x-stream-index: "013" + x-stream-index: "012" message: - $ref: '#/components/schemas/Message' - x-stream-index: "007" + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "006" message_update: $ref: '#/components/schemas/MessageUpdate' - x-stream-index: "008" + x-stream-index: "007" parent_id: type: string - x-stream-index: "024" + x-stream-index: "023" poll: - $ref: '#/components/schemas/Poll' - x-stream-index: "014" + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "013" poll_vote: - $ref: '#/components/schemas/PollVote' - x-stream-index: "015" + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "014" reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "009" + $ref: '#/components/schemas/ReactionResponse' + x-stream-index: "008" reason: type: string - x-stream-index: "020" + x-stream-index: "019" team: type: string - x-stream-index: "025" + x-stream-index: "024" thread: $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "012" + x-stream-index: "011" thread_id: type: string - x-stream-index: "011" + x-stream-index: "010" type: type: string x-stream-index: "001" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "016" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "015" user_id: type: string - x-stream-index: "017" + x-stream-index: "016" watcher_count: format: int32 type: integer - x-stream-index: "019" + x-stream-index: "018" required: - type - custom @@ -15775,6 +17617,7 @@ components: type: object x-stream-docs-page-id: event_object WrappedUnreadCountsResponse: + description: Basic response information nullable: true properties: channel_type: @@ -15812,6 +17655,7 @@ components: - channel_type - threads - duration + title: Response type: object XiaomiConfig: properties: @@ -15881,7 +17725,7 @@ components: type: apiKey info: title: Stream API - version: v133.1.0 + version: v137.0.0 openapi: 3.0.3 paths: /api/v2/app: @@ -15895,7 +17739,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetApplicationResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15927,7 +17771,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -15954,7 +17798,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListBlockListResponse' - description: Successful response + description: Response "400": content: application/json: @@ -15987,7 +17831,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16024,7 +17868,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16060,7 +17904,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetBlockListResponse' - description: Get Block list response + description: GetBlockListResponse "400": content: application/json: @@ -16094,16 +17938,171 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListRequest' - description: Update block list + $ref: '#/components/schemas/UpdateBlockListRequest' + description: Update block list + 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: 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" + 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 + operationId: QueryCampaigns + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCampaignsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Successful response + $ref: '#/components/schemas/QueryCampaignsResponse' + description: Response "400": content: application/json: @@ -16116,9 +18115,9 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update block list + summary: Query campaign tags: - - product:common + - product:chat /api/v2/chat/channels: post: description: | @@ -16197,7 +18196,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16249,6 +18248,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest required: true responses: "200": @@ -16374,7 +18374,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EventResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16431,7 +18431,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16535,7 +18535,7 @@ paths: application/json: schema: $ref: '#/components/schemas/HideChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -16592,7 +18592,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -16988,7 +18988,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShowChannelResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17094,7 +19094,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -17250,7 +19250,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListChannelTypesResponse' - description: Successful response + description: ListChannelTypesResponse "400": content: application/json: @@ -17275,6 +19275,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateChannelTypeRequest' + description: CreateChannelTypeRequest required: true responses: "201": @@ -17319,7 +19320,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -17355,7 +19356,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetChannelTypeResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17422,7 +19423,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListCommandsResponse' - description: Successful response + description: ListCommandsResponse "400": content: application/json: @@ -17447,7 +19448,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCommandRequest' - description: Command + description: CreateCommandRequest required: true responses: "201": @@ -17455,7 +19456,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCommandResponse' - description: Successful response + description: CreateCommandResponse "400": content: application/json: @@ -17481,6 +19482,8 @@ paths: name: name required: true schema: + description: Command name + title: Name type: string x-stream-index: "001" responses: @@ -17489,7 +19492,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCommandResponse' - description: Successful response + description: DeleteCommandResponse "400": content: application/json: @@ -17514,6 +19517,8 @@ paths: name: name required: true schema: + description: Command name + title: Name type: string x-stream-index: "001" responses: @@ -17522,7 +19527,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCommandResponse' - description: Successful response + description: GetCommandResponse "400": content: application/json: @@ -17557,7 +19562,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCommandRequest' - description: Command + description: UpdateCommandRequest required: true responses: "201": @@ -17565,7 +19570,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCommandResponse' - description: Successful response + description: UpdateCommandResponse "400": content: application/json: @@ -17730,7 +19735,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17777,7 +19782,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17828,7 +19833,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17926,7 +19931,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -17971,7 +19976,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18022,7 +20027,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendReactionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18082,7 +20087,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactionRemovalResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18183,7 +20188,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryReactionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18231,7 +20236,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18277,7 +20282,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateMessageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18513,7 +20518,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetRepliesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18586,7 +20591,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: Successful response + description: QueryMessageFlagsResponse "400": content: application/json: @@ -18664,7 +20669,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteResponse' - description: Successful response + description: Response "400": content: application/json: @@ -18789,7 +20794,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -19035,7 +21040,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -19163,19 +21168,255 @@ paths: type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QueryPollsRequest' + 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 + /api/v2/chat/query_banned_users: + get: + description: | + Find and filter channel scoped or global user bans + + Required permissions: + - ReadChannel + 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/search: + get: + description: | + Search messages across channels + + Required permissions: + - ReadChannel + 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: | + Delete a segment + 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 + 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 + 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 + 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: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryPollsResponse' - description: Successful response + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -19188,33 +21429,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query polls + summary: Check whether a target exists in a segment tags: - product:chat - /api/v2/chat/query_banned_users: - get: + /api/v2/chat/segments/{id}/targets/query: + post: description: | - Find and filter channel scoped or global user bans - - Required permissions: - - ReadChannel - operationId: QueryBannedUsers + Query segment targets + operationId: ControllerNameQuerySegmentTargets parameters: - - content: + - 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/QueryBannedUsersPayload' - description: JSON object with query user bans payload - title: Payload - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/QuerySegmentTargetsRequest' + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/QueryBannedUsersResponse' + $ref: '#/components/schemas/QuerySegmentTargetsResponse' description: Successful response "400": content: @@ -19228,33 +21471,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Banned Users + summary: Query segment targets tags: - product:chat - /api/v2/chat/search: - get: + /api/v2/chat/segments/query: + post: description: | - Search messages across channels - - Required permissions: - - ReadChannel - operationId: Search - parameters: - - content: + Query segments + operationId: QuerySegments + 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/QuerySegmentsRequest' + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/SearchResponse' + $ref: '#/components/schemas/QuerySegmentsResponse' description: Successful response "400": content: @@ -19268,7 +21504,7 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Search messages + summary: Query segments tags: - product:chat /api/v2/chat/threads: @@ -19323,12 +21559,6 @@ paths: type: string writeOnly: true x-stream-index: "001" - - in: query - name: connection_id - schema: - type: string - writeOnly: true - x-stream-index: "003" - in: query name: reply_limit schema: @@ -19441,7 +21671,7 @@ paths: application/json: schema: $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19474,7 +21704,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnreadCountsBatchResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19518,7 +21748,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -19544,6 +21774,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CheckPushRequest' + description: CheckPushRequest required: true responses: "201": @@ -19662,7 +21893,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -19697,7 +21928,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListDevicesResponse' - description: Successful response + description: ListDevicesResponse "400": content: application/json: @@ -19722,6 +21953,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": @@ -19729,7 +21961,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -19762,7 +21994,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExportUsersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19789,7 +22021,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19821,7 +22053,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19856,7 +22088,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19896,7 +22128,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19931,7 +22163,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CheckExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -19997,7 +22229,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateImportURLResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20024,7 +22256,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListImportsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20056,7 +22288,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateImportResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20091,7 +22323,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetImportResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20124,7 +22356,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BanResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20157,7 +22389,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CheckResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20190,7 +22422,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpsertConfigResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20224,7 +22456,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteModerationConfigResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20257,7 +22489,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetConfigResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20290,7 +22522,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryModerationConfigsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20323,7 +22555,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CustomCheckResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20350,7 +22582,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteModerationTemplateResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20376,7 +22608,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryFeedModerationTemplatesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20408,7 +22640,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpsertModerationTemplateResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20441,7 +22673,7 @@ paths: application/json: schema: $ref: '#/components/schemas/FlagResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20474,7 +22706,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryModerationLogsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20501,7 +22733,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ModeratorStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20527,6 +22759,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteRequest' + description: MuteRequest required: true responses: "201": @@ -20534,7 +22767,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteResponse' - description: Successful response + description: MuteResponse "400": content: application/json: @@ -20561,7 +22794,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueueStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20594,7 +22827,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryReviewQueueResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20629,7 +22862,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetReviewQueueItemResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20662,7 +22895,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SubmitActionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20715,7 +22948,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnbanResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20741,6 +22974,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteRequest' + description: UnmuteRequest required: true responses: "201": @@ -20748,7 +22982,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnmuteResponse' - description: Successful response + description: UnmuteResponse "400": content: application/json: @@ -20781,7 +23015,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryUsageStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20834,7 +23068,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetUserModerationReportResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20898,7 +23132,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListPermissionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20935,7 +23169,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCustomPermissionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20962,7 +23196,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListPushProvidersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -20994,7 +23228,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpsertPushProviderResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21043,7 +23277,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -21139,7 +23373,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListRolesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21171,7 +23405,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateRoleResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21208,7 +23442,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -21573,6 +23807,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeactivateUsersRequest' + description: DeactivateUsersRequest required: true responses: "201": @@ -21580,7 +23815,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeactivateUsersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21646,6 +23881,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactivateUsersRequest' + description: ReactivateUsersRequest required: true responses: "201": @@ -21653,7 +23889,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReactivateUsersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -21686,7 +23922,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -21797,7 +24033,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallResponse' - description: Successful response + description: GetCallResponse "400": content: application/json: @@ -21849,6 +24085,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallRequest' + description: UpdateCallRequest required: true responses: "200": @@ -21856,7 +24093,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallResponse' - description: Call + description: UpdateCallResponse "400": content: application/json: @@ -21912,6 +24149,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallRequest' + description: GetOrCreateCallRequest required: true responses: "201": @@ -21919,7 +24157,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallResponse' - description: Successful response + description: GetOrCreateCallResponse "400": content: application/json: @@ -21986,7 +24224,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteRecordingResponse' - description: Successful response + description: DeleteRecordingResponse "400": content: application/json: @@ -22053,7 +24291,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteTranscriptionResponse' - description: Successful response + description: DeleteTranscriptionResponse "400": content: application/json: @@ -22106,6 +24344,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserRequest' + description: BlockUserRequest required: true responses: "201": @@ -22113,7 +24352,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserResponse' - description: Successful response + description: BlockUserResponse "400": content: application/json: @@ -22166,6 +24405,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallRequest' + description: DeleteCallRequest required: true responses: "201": @@ -22173,7 +24413,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallResponse' - description: Successful response + description: DeleteCallResponse "400": content: application/json: @@ -22224,6 +24464,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventRequest' + description: SendCallEventRequest required: true responses: "201": @@ -22231,7 +24472,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventResponse' - description: Successful response + description: SendCallEventResponse "400": content: application/json: @@ -22292,7 +24533,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CollectUserFeedbackResponse' - description: Successful response + description: Response "400": content: application/json: @@ -22345,6 +24586,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveRequest' + description: GoLiveRequest required: true responses: "201": @@ -22352,7 +24594,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveResponse' - description: Successful response + description: Response "400": content: application/json: @@ -22406,7 +24648,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EndCallResponse' - description: Successful response + description: EndCallResponse "400": content: application/json: @@ -22463,6 +24705,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersRequest' + description: UpdateCallMembersRequest required: true responses: "201": @@ -22470,7 +24713,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -22520,6 +24763,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersRequest' + description: MuteUsersRequest required: true responses: "201": @@ -22527,7 +24771,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersResponse' - description: Successful response + description: MuteUsersResponse "400": content: application/json: @@ -22573,6 +24817,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinRequest' + description: PinRequest required: true responses: "201": @@ -22580,7 +24825,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinResponse' - description: Successful response + description: Response "400": content: application/json: @@ -22627,7 +24872,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListRecordingsResponse' - description: Successful response + description: ListRecordingsResponse "400": content: application/json: @@ -22677,6 +24922,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsRequest' + description: StartRTMPBroadcastsRequest required: true responses: "201": @@ -22684,7 +24930,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsResponse' - description: Successful response + description: StartRTMPBroadcastsResponse "400": content: application/json: @@ -22741,6 +24987,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsRequest' + description: StopRTMPBroadcastsRequest required: true responses: "201": @@ -22748,7 +24995,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -22799,7 +25046,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopAllRTMPBroadcastsResponse' - description: Successful response + description: StopAllRTMPBroadcastsResponse "400": content: application/json: @@ -22850,7 +25097,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartHLSBroadcastingResponse' - description: Successful response + description: StartHLSBroadcastingResponse "400": content: application/json: @@ -22866,6 +25113,57 @@ paths: summary: Start HLS broadcasting tags: - product:video + /api/v2/video/call/{type}/{id}/start_closed_captions: + post: + description: | + Starts closed captions + + Required permissions: + - StartClosedCaptions + 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" + 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_recording: post: description: | @@ -22903,6 +25201,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingRequest' + description: StartRecordingRequest required: true responses: "201": @@ -22910,7 +25209,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingResponse' - description: Successful response + description: StartRecordingResponse "400": content: application/json: @@ -22960,6 +25259,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionRequest' + description: StartTranscriptionRequest required: true responses: "201": @@ -22967,7 +25267,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionResponse' - description: Successful response + description: StartTranscriptionResponse "400": content: application/json: @@ -23022,7 +25322,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -23069,7 +25369,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopHLSBroadcastingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -23085,6 +25385,56 @@ paths: summary: Stop HLS broadcasting tags: - product:video + /api/v2/video/call/{type}/{id}/stop_closed_captions: + post: + description: | + Stops closed captions + + Sends events: + - call.transcription_stopped + + Required permissions: + - StopClosedCaptions + 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" + 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_live: post: description: |2 @@ -23123,7 +25473,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopLiveResponse' - description: Successful response + description: StopLiveResponse "400": content: application/json: @@ -23173,7 +25523,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRecordingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -23223,7 +25573,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopTranscriptionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -23252,7 +25602,9 @@ paths: name: type required: true schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true x-stream-index: "001.001" @@ -23260,7 +25612,9 @@ paths: name: id required: true schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true x-stream-index: "001.002" @@ -23270,7 +25624,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListTranscriptionsResponse' - description: Successful response + description: ListTranscriptionsResponse "400": content: application/json: @@ -23321,6 +25675,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserRequest' + description: UnblockUserRequest required: true responses: "201": @@ -23328,7 +25683,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserResponse' - description: Successful response + description: UnblockUserResponse "400": content: application/json: @@ -23374,6 +25729,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinRequest' + description: UnpinRequest required: true responses: "201": @@ -23381,7 +25737,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinResponse' - description: Successful response + description: UnpinResponse "400": content: application/json: @@ -23437,7 +25793,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateUserPermissionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -23473,7 +25829,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -23509,7 +25865,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -23538,6 +25894,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsRequest' + description: QueryCallsRequest required: true responses: "201": @@ -23545,7 +25902,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsResponse' - description: Successful response + description: QueryCallsResponse "400": content: application/json: @@ -23572,7 +25929,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListCallTypeResponse' - description: Successful response + description: ListCallTypeResponse "400": content: application/json: @@ -23597,6 +25954,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCallTypeRequest' + description: CreateCallTypeRequest required: true responses: "201": @@ -23604,7 +25962,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCallTypeResponse' - description: Successful response + description: CreateCallTypeResponse "400": content: application/json: @@ -23639,7 +25997,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -23673,7 +26031,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallTypeResponse' - description: Successful response + description: GetCallTypeResponse "400": content: application/json: @@ -23706,6 +26064,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallTypeRequest' + description: UpdateCallTypeRequest required: true responses: "201": @@ -23713,7 +26072,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallTypeResponse' - description: Successful response + description: UpdateCallTypeResponse "400": content: application/json: @@ -23740,7 +26099,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetEdgesResponse' - description: Successful response + description: Response "400": content: application/json: diff --git a/openapi/video-openapi-clientside.json b/openapi/video-openapi-clientside.json index a806d56a..b4306a82 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":{"nullable":true,"type":"object"},"AcceptCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":"string","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/UserObject","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"type":"object"},"Attachment":{"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"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"011"},"expires":{"format":"date-time","type":"string","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["shadow","created_at"],"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"},"BlockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"BlockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"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-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"}},"required":["text","start_time","end_time","speaker_id"],"type":"object"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallEvent":{"nullable":true,"properties":{"additional":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"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":"003"},"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","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","x-stream-index":"001"}},"required":["rtmp"],"title":"Call inputs","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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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"},"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"],"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"},"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"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"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"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"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":{"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRequest":{"properties":{"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"}},"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"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":"020"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"string","x-stream-index":"013"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"018"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"022"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"019"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"016"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"014"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"021"},"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","backstage","settings","blocked_user_ids","ingress","egress"],"title":"Call","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-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-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-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-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-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-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-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"},"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"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"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-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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"type":"object"},"CallStateResponseFields":{"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"],"type":"object"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"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"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"truncated_by":{"$ref":"#/components/schemas/UserObject","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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.025"},"blocklist":{"type":"string","x-stream-index":"001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.023"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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"},"title":"Grants","type":"object","x-stream-index":"002","x-stream-map":{"key":"role","title":"Grants","description":"List of grants modifiers that apply to a role"}},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"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"}},"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","message_retention","max_message_length","automod","automod_behavior","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"017"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"016"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"021"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"014"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"009"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"010"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"008"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"022"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"title":"User ID","type":"string","x-stream-index":"004"}},"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","x-stream-index":"007"},"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"},"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/UserObject","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"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":"021"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"022"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"027"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"Config","x-stream-index":"017"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"024"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/UserObject","description":"Creator of the channel","title":"Created by","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"012"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"026"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"023"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"003"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"string","x-stream-index":"006"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"015"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"014"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"string","x-stream-index":"019"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"018"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"type":"string"},"title":"Own Capabilities","type":"array","x-stream-index":"025"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"020"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"Truncated At","type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/UserObject","x-stream-index":"029"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","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-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":["user_session_id","sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["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"},"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"type":"object"},"CreateDeviceRequest":{"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"],"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteCallRequest":{"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"}},"type":"object"},"DeleteCallResponse":{"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":"003.001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["call","duration"],"type":"object"},"DeleteRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"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":"Device","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"}},"required":["playlist_url"],"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"},"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":{"nullable":true,"type":"object"},"EndCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"time":{"$ref":"#/components/schemas/Time","x-stream-index":"007"},"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"},"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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"],"type":"object"},"GetCallStatsResponse":{"nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"type":"object"},"GetEdgesResponse":{"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"],"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"}},"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"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"type":"object"},"GoLiveResponse":{"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"],"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"],"type":"object"},"HLSSettingsResponse":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"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"},"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"],"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"},"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"},"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"},"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"],"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"],"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"},"LayoutSettingsRequest":{"properties":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"type":"object"},"ListRecordingsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"items":{"$ref":"#/components/schemas/CallTranscription"},"type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"type":"object"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"type":"object"},"MemberRequest":{"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"],"type":"object"},"MemberResponse":{"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"],"type":"object"},"Message":{"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":"011"},"before_message_send_failed":{"description":"Whether `before_message_send webhook` failed or not. Field is only accessible in push webhook","title":"Before Message Send Failed","type":"boolean","x-stream-docs-page-id":"before_message_send_webhook","x-stream-index":"045"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"027"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"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":"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":"043"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","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":"039"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Latest reactions","type":"array","x-stream-index":"012"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserObject"},"title":"Mentioned Users","type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"051"},"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":"005"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/Reaction"},"title":"Own reactions","type":"array","x-stream-index":"013"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"018"},"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":"050"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"046"},"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":"047"},"pinned_by":{"$ref":"#/components/schemas/UserObject","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"024"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"023"},"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":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"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":"015"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"021"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"035"},"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":"020"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"044"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"004"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserObject"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"026"},"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":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/UserObject","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"010"}},"required":["id","text","html","type","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"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","type":"object","x-stream-event-client-type":true,"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"},"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"},"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"}},"type":"object"},"MuteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"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"],"type":"object"},"PinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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/UserObject","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"},"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/UserObject","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"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":{"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"],"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":{"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"],"type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"004"},"watch":{"type":"boolean","x-stream-index":"001"}},"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"],"type":"object"},"RTMPBroadcastRequest":{"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"],"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMP Ingress","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"}},"type":"object"},"RTMPSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"type":"object"},"Reaction":{"description":"Represents user reaction to a message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"description":"ID of a message user reacted to","title":"Message ID","type":"string","x-stream-index":"003"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"007"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"005"},"user_id":{"description":"ID of a user who reacted to a message","title":"User ID","type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"string","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"string","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"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"}},"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"],"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"],"type":"object"},"RecordSettingsResponse":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"027"},"assigned_to":{"$ref":"#/components/schemas/UserObject","x-stream-index":"024"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"025"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"016"},"content_changed":{"type":"boolean","x-stream-index":"028"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/UserObject","x-stream-index":"023"},"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":"029"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"030"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"022"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"015"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"019"},"reviewed_by":{"type":"string","x-stream-index":"020"},"severity":{"format":"int32","type":"integer","x-stream-index":"018"},"status":{"type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"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"],"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"},"StartHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StartHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"playlist_url":{"type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"type":"object"},"StartRTMPBroadcastsRequest":{"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"],"type":"object"},"StartRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StatsOptions":{"properties":{"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"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"],"type":"object"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopLiveRequest":{"nullable":true,"type":"object"},"StopLiveResponse":{"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"],"type":"object"},"StopRTMPBroadcastsRequest":{"nullable":true,"type":"object"},"StopRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopTranscriptionRequest":{"nullable":true,"type":"object"},"StopTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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"},"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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"UnblockUserResponse":{"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":"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"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"],"type":"object"},"UnpinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UpdateCallMembersRequest":{"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"}},"type":"object"},"UpdateCallMembersResponse":{"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"],"type":"object"},"UpdateCallRequest":{"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"}},"type":"object"},"UpdateCallResponse":{"description":"Represents 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":"Call","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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["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":"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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/UserObject","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/UserObject","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-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/UserObject","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserObject","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"image":{"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"004"}},"required":["name","image","custom","roles"],"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/UserObject","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserObject":{"description":"Represents chat user","properties":{"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"015"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"014"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","readOnly":true,"title":"Deactivated at","type":"string","x-stream-index":"012"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","readOnly":true,"title":"Deleted at","type":"string","x-stream-index":"011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"021"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"032"},"last_active":{"description":"Date of last activity","format":"date-time","readOnly":true,"title":"Last active","type":"string","x-stream-index":"010"},"online":{"description":"Whether a user online or not","readOnly":true,"title":"Online","type":"boolean","x-stream-index":"020"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"024"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"023"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"039"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"004"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"033"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"008"}},"required":["id","role","custom","banned","online"],"title":"User object","type":"object"},"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/UserObject","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","type":"object","x-stream-event-client-type":true,"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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"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/UserObject","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-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/UserObject","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","type":"object","x-stream-event-client-type":true,"x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoResolution","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"VideoResolution":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"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":{"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"],"type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","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.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.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_muted":"#/components/schemas/CallUserMutedEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","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.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"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$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/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/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$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"}]},"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.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","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.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_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","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_muted":"#/components/schemas/CallUserMutedEvent","custom":"#/components/schemas/CustomVideoEvent","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.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.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$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/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/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$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/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":"v133.1.0"},"openapi":"3.0.3","paths":{"/video/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCallStats\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"Call"},"400":{"content":{"application/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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- JoinCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- SendEvent\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"Successful response"},"400":{"content":{"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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateCall\n- JoinCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- EndCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteUsers\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- CreateCallReaction\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListRecordings\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- JoinCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"Successful response"},"400":{"content":{"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}/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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":"Successful response"},"400":{"content":{"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartTranscription\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":"Successful response"},"400":{"content":{"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopRecording\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopTranscription\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListTranscriptions\n","operationId":"ListTranscriptions","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/ListTranscriptionsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCallPermissions\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteRecording\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteTranscription\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://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"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","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"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"type":"object"},"Attachment":{"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":"021"},"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":"022"},"image_url":{"type":"string","x-stream-index":"011"},"latitude":{"format":"float","type":"number","x-stream-index":"018"},"longitude":{"format":"float","type":"number","x-stream-index":"019"},"og_scrape_url":{"type":"string","x-stream-index":"023"},"original_height":{"format":"int32","type":"integer","x-stream-index":"025"},"original_width":{"format":"int32","type":"integer","x-stream-index":"024"},"pretext":{"type":"string","x-stream-index":"004"},"stopped_sharing":{"type":"boolean","x-stream-index":"020"},"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":{"type":"string","x-stream-index":"001"}},"required":["custom"],"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"},"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":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"string","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"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallEvent":{"nullable":true,"properties":{"category":{"type":"string","x-stream-index":"009"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"issue_tags":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"kind":{"type":"string","x-stream-index":"008"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal","kind"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"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":"003"},"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","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"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-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-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-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-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-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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"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-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"},"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"],"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"},"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"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"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"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"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":{"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"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"},"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-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-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-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-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-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-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-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"},"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"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"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-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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"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"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"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"},"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"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"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":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"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"},"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"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Channel":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"028"},"auto_translation_language":{"type":"string","x-stream-index":"029"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"025"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"026"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"030"},"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":"018"},"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":"021"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"020"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"019"},"team":{"type":"string","x-stream-index":"027"},"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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.025"},"blocklist":{"type":"string","x-stream-index":"001.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.023"},"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.018"},"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.026"},"partition_ttl":{"type":"integer","x-stream-index":"001.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.028"},"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"}},"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","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.024"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.019"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.020"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.025"},"blocklist":{"type":"string","x-stream-index":"001.002.021"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.023"},"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.018"},"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.026"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.027"},"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"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.028"},"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"}},"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","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":"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"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","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","create-call","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-call","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-typing-events","set-channel-cooldown","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":"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"},"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-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":["user_session_id","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":"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"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"}},"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"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"}},"required":["playlist_url"],"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"},"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"},"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"},"time":{"$ref":"#/components/schemas/Time","x-stream-index":"007"},"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":{"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"001.016"},"banned":{"type":"boolean","x-stream-index":"001.015"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.012"},"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.022"},"language":{"type":"string","x-stream-index":"001.033"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"001.024"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.040"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.034"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.008"}},"required":["id","role","custom","banned","online","ban_count","deleted_content_count"],"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"},"Flag2":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"013"},"entity_creator_id":{"type":"string","x-stream-index":"009"},"entity_id":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"007"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"type":"string","x-stream-index":"012"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"015"},"review_queue_item_id":{"type":"string","x-stream-index":"016"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"018"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"},"GetCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"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"},"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_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"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"},"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"},"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"],"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"},"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"},"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"},"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"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"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"011"},"before_message_send_failed":{"type":"boolean","x-stream-index":"045"},"cid":{"type":"string","x-stream-index":"027"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"029"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"033"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"032"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"043"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"039"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"012"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"042"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"051"},"mml":{"type":"string","x-stream-index":"005"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"parent_id":{"type":"string","x-stream-index":"018"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"050"},"pinned":{"type":"boolean","x-stream-index":"046"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"047"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"049"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"053"},"poll_id":{"type":"string","x-stream-index":"052"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"024"},"quoted_message_id":{"type":"string","x-stream-index":"023"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"016"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"021"},"shadowed":{"type":"boolean","x-stream-index":"035"},"show_in_channel":{"type":"boolean","x-stream-index":"020"},"silent":{"type":"boolean","x-stream-index":"044"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"026"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"030"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"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"},"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"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUserResponse":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"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.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"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.009"}},"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"},"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-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":"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"},"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"},"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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettings":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"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"},"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"},"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"},"ReactionGroupResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"001"},"first_reaction_at":{"format":"date-time","type":"string","x-stream-index":"003"},"last_reaction_at":{"format":"date-time","type":"string","x-stream-index":"004"},"sum_scores":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"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"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"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"},"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"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"028"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"025"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"026"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"017"},"content_changed":{"type":"boolean","x-stream-index":"029"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"024"},"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":"030"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"031"},"flags":{"items":{"$ref":"#/components/schemas/Flag2"},"type":"array","x-stream-index":"027"},"has_image":{"type":"boolean","x-stream-index":"011"},"has_text":{"type":"boolean","x-stream-index":"013"},"has_video":{"type":"boolean","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"023"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"009"},"moderation_payload_hash":{"type":"string","x-stream-index":"010"},"recommended_action":{"type":"string","x-stream-index":"016"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"020"},"reviewed_by":{"type":"string","x-stream-index":"021"},"severity":{"format":"int32","type":"integer","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"015"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","reviewed_at","reviewed_by","bans","flags","actions","content_changed"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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"},"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,"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartTranscriptionRequest","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":{"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms"],"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,"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"},"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,"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,"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"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"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"},"Time":{"type":"object"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"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"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"},"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"ban_expires":{"format":"date-time","type":"string","x-stream-index":"016"},"banned":{"type":"boolean","x-stream-index":"015"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"022"},"language":{"type":"string","x-stream-index":"033"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"010"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"021"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"025"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettings","x-stream-index":"024"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"040"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"034"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"}},"required":["id","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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserEventPayload":{"properties":{"banned":{"type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.015"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.010"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"002"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.013"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.012"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.014"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"002"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"005"}},"required":["id","name","image","custom","roles"],"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-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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"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-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-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UserUpdatedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"type":{"default":"user.updated","type":"string","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserEventPayload","x-stream-index":"001"}},"required":["user","type","created_at"],"type":"object"},"VideoDimension":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoDimension","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"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":{"health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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":{"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.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.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.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_muted":"#/components/schemas/CallUserMutedEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","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.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"},"propertyName":"type"},"oneOf":[{"$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/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/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/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$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"}]},"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.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.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_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","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_muted":"#/components/schemas/CallUserMutedEvent","custom":"#/components/schemas/CustomVideoEvent","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.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.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$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/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/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/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$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/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":"v137.0.0"},"openapi":"3.0.3","paths":{"/video/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- ReadCallStats\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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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\nRequired permissions:\n- JoinCall\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- DeleteCall\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\nRequired permissions:\n- SendEvent\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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- JoinCall\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\nRequired permissions:\n- EndCall\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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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\nRequired permissions:\n- MuteUsers\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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- CreateCallReaction\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\nRequired permissions:\n- ListRecordings\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\nRequired permissions:\n- JoinCall\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}/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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StartClosedCaptions\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"}}],"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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\nRequired permissions:\n- StartTranscription\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"}}},"description":"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopClosedCaptions\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"}}],"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"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\nRequired permissions:\n- StopRecording\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\nRequired permissions:\n- StopTranscription\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"}}],"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\nRequired permissions:\n- ListTranscriptions\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- UpdateCallPermissions\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\nRequired permissions:\n- DeleteRecording\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\nRequired permissions:\n- DeleteTranscription\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\nRequired permissions:\n- ReadCall\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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://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 a2239860..000e3a27 100644 --- a/openapi/video-openapi-clientside.yaml +++ b/openapi/video-openapi-clientside.yaml @@ -60,16 +60,22 @@ components: 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 @@ -121,7 +127,7 @@ components: type: string x-stream-index: "012" target_user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "013" target_user_id: type: string @@ -130,7 +136,7 @@ components: type: string x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "007" required: - id @@ -182,7 +188,7 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "018" + x-stream-index: "021" fallback: type: string x-stream-index: "002" @@ -199,24 +205,35 @@ components: x-stream-index: "014" giphy: $ref: '#/components/schemas/Images' - x-stream-index: "019" + x-stream-index: "022" image_url: type: string x-stream-index: "011" + latitude: + format: float + type: number + x-stream-index: "018" + longitude: + format: float + type: number + x-stream-index: "019" og_scrape_url: type: string - x-stream-index: "020" + x-stream-index: "023" original_height: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "025" original_width: format: int32 type: integer - x-stream-index: "021" + x-stream-index: "024" pretext: type: string x-stream-index: "004" + stopped_sharing: + type: boolean + x-stream-index: "020" text: type: string x-stream-index: "010" @@ -230,15 +247,11 @@ components: 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: @@ -335,7 +348,7 @@ components: type: string x-stream-index: "012" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "011" expires: format: date-time @@ -348,7 +361,7 @@ components: type: boolean x-stream-index: "009" target: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "006" required: - shadow @@ -357,13 +370,17 @@ components: 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: @@ -371,6 +388,7 @@ components: - behavior type: object BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. nullable: true properties: user_id: @@ -380,8 +398,10 @@ components: 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: @@ -391,6 +411,7 @@ components: x-stream-index: "001.001" required: - duration + title: BlockUserResponse type: object BlockedUserEvent: description: |- @@ -444,20 +465,25 @@ components: 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 @@ -516,12 +542,94 @@ components: 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-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-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-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 @@ -634,10 +742,9 @@ components: CallEvent: nullable: true properties: - additional: - additionalProperties: {} - type: object - x-stream-index: "008" + category: + type: string + x-stream-index: "009" component: type: string x-stream-index: "007" @@ -651,6 +758,14 @@ components: internal: type: boolean x-stream-index: "006" + issue_tags: + items: + type: string + type: array + x-stream-index: "010" + kind: + type: string + x-stream-index: "008" severity: format: int32 type: integer @@ -669,6 +784,7 @@ components: - description - type - internal + - kind type: object CallHLSBroadcastingFailedEvent: description: This event is sent when HLS broadcasting has failed @@ -753,13 +869,15 @@ components: 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: Call inputs + title: CallIngressResponse type: object CallLiveStartedEvent: description: This event is sent when a call is started. Clients receiving this @@ -1147,6 +1265,7 @@ components: - url - start_time - end_time + title: CallRecording type: object CallRecordingFailedEvent: description: This event is sent when call recording has failed @@ -1294,6 +1413,7 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent CallRequest: + description: CallRequest is the payload for creating a call. properties: custom: additionalProperties: {} @@ -1318,18 +1438,22 @@ components: video: type: boolean x-stream-index: "008" + title: CallRequest type: object CallResponse: description: Represents a call properties: backstage: type: boolean - x-stream-index: "015" + x-stream-index: "016" blocked_user_ids: items: type: string type: array - x-stream-index: "017" + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" cid: description: The unique identifier for a call (:) title: CID @@ -1357,13 +1481,13 @@ components: x-stream-index: "008" egress: $ref: '#/components/schemas/EgressResponse' - x-stream-index: "020" + x-stream-index: "021" ended_at: description: Date/time when the call ended format: date-time title: Ended At type: string - x-stream-index: "013" + x-stream-index: "014" id: description: Call ID title: ID @@ -1371,32 +1495,32 @@ components: x-stream-index: "003" ingress: $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "018" + x-stream-index: "019" join_ahead_time_seconds: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "023" recording: type: boolean x-stream-index: "011" session: $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "019" + x-stream-index: "020" settings: $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "016" + 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: "014" + x-stream-index: "015" team: type: string x-stream-index: "006" thumbnails: $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "021" + x-stream-index: "022" transcribing: type: boolean x-stream-index: "012" @@ -1422,12 +1546,13 @@ components: - updated_at - recording - transcribing + - captioning - backstage - settings - blocked_user_ids - ingress - egress - title: Call + title: CallResponse type: object CallRingEvent: description: This event is sent to all call members to notify they are getting @@ -1937,6 +2062,7 @@ components: - limits type: object CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response properties: call: $ref: '#/components/schemas/CallResponse' @@ -1963,6 +2089,7 @@ components: - members - own_capabilities - blocked_users + title: CallStateResponseFields type: object CallStatsReportSummaryResponse: properties: @@ -2034,6 +2161,7 @@ components: - url - start_time - end_time + title: CallTranscription type: object CallTranscriptionFailedEvent: description: This event is sent when call transcription has failed @@ -2234,7 +2362,7 @@ components: $ref: '#/components/schemas/ChannelConfig' x-stream-index: "025" config_overrides: - $ref: '#/components/schemas/ChannelConfig' + $ref: '#/components/schemas/ConfigOverrides' x-stream-index: "026" cooldown: format: int32 @@ -2245,7 +2373,7 @@ components: type: string x-stream-index: "009" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "008" custom: additionalProperties: {} @@ -2286,7 +2414,7 @@ components: type: string x-stream-index: "027" truncated_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "015" type: type: string @@ -2346,10 +2474,8 @@ components: type: array x-stream-index: "001.023" commands: - description: List of commands that channel supports items: type: string - title: Commands type: array x-stream-index: "003" connect_events: @@ -2381,10 +2507,7 @@ components: type: integer x-stream-index: "001.026" partition_ttl: - example: 24h - format: duration - nullable: true - type: string + type: integer x-stream-index: "001.027" polls: type: boolean @@ -2410,6 +2533,9 @@ components: search: type: boolean x-stream-index: "001.005" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.028" typing_events: type: boolean x-stream-index: "001.002" @@ -2444,6 +2570,7 @@ components: - max_message_length - automod - automod_behavior + - skip_last_msg_update_for_system_msgs - created_at - updated_at - commands @@ -2507,13 +2634,8 @@ components: items: type: string type: array - title: Grants type: object x-stream-index: "002" - x-stream-map: - description: List of grants modifiers that apply to a role - key: role - title: Grants mark_messages_pending: type: boolean x-stream-index: 001.002.015 @@ -2562,6 +2684,9 @@ components: search: type: boolean x-stream-index: 001.002.005 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.028 typing_events: type: boolean x-stream-index: 001.002.002 @@ -2598,87 +2723,107 @@ components: - 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: string + x-stream-index: "015" ban_expires: description: Expiration date of the ban format: date-time title: Ban expires type: string - x-stream-index: "017" + x-stream-index: "013" banned: description: Whether member is banned this channel or not title: Banned type: boolean - x-stream-index: "016" + x-stream-index: "012" channel_role: description: Role of the member in the channel title: Channel Role type: string - x-stream-index: "021" + x-stream-index: "018" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "012" + x-stream-index: "009" custom: additionalProperties: {} type: object - x-stream-index: "006" + x-stream-index: "004" deleted_at: format: date-time type: string - x-stream-index: "014" + 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: "009" + 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: "010" + x-stream-index: "007" invited: description: Whether member was invited or not title: Invited type: boolean - x-stream-index: "008" + x-stream-index: "005" is_moderator: description: Whether member is channel moderator or not title: Is moderator type: boolean - x-stream-index: "007" + x-stream-index: "003" notifications_muted: type: boolean - x-stream-index: "022" + 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: "019" + x-stream-index: "014" status: type: string - x-stream-index: "011" + x-stream-index: "008" updated_at: description: Date/time of the last update format: date-time title: Updated at type: string - x-stream-index: "013" + x-stream-index: "010" user: - $ref: '#/components/schemas/UserObject' - x-stream-index: "005" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" user_id: title: User ID type: string - x-stream-index: "004" + x-stream-index: "001" required: - custom - created_at @@ -2694,34 +2839,75 @@ components: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "007" + x-stream-index: "002" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "009" + x-stream-index: "004" expires: description: Date/time of mute expiration format: date-time title: Expires type: string - x-stream-index: "008" + x-stream-index: "003" updated_at: description: Date/time of the last update format: date-time title: Updated at type: string - x-stream-index: "010" + x-stream-index: "005" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Owner of channel mute title: User - x-stream-index: "005" + 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 + - create-call + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-call + - 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-typing-events + - set-channel-cooldown + - 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: @@ -2729,141 +2915,143 @@ components: description: Whether auto translation is enabled or not title: Auto translation type: boolean - x-stream-index: "021" + 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: "022" + x-stream-index: "018" blocked: description: Whether this channel is blocked by current user or not title: Blocked type: boolean - x-stream-index: "027" + x-stream-index: "023" cid: description: Channel CID (:) title: CID type: string - x-stream-index: "005" + x-stream-index: "003" config: $ref: '#/components/schemas/ChannelConfigWithInfo' description: Channel configuration - title: Config - x-stream-index: "017" + title: ChannelConfigWithInfo + x-stream-index: "013" cooldown: description: Cooldown period after sending each message format: int32 title: Cooldown type: integer - x-stream-index: "024" + x-stream-index: "020" created_at: description: Date/time of creation format: date-time title: Created at type: string - x-stream-index: "008" + x-stream-index: "005" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/UserResponse' description: Creator of the channel - title: Created by - x-stream-index: "011" + title: UserResponse + x-stream-index: "008" custom: additionalProperties: {} + description: Custom data for this object + title: Custom data type: object - x-stream-index: "030" + x-stream-index: "026" deleted_at: description: Date/time of deletion format: date-time title: Deleted at type: string - x-stream-index: "010" + x-stream-index: "007" disabled: type: boolean - x-stream-index: "013" + x-stream-index: "010" frozen: description: Whether channel is frozen or not title: Frozen type: boolean - x-stream-index: "012" + x-stream-index: "009" hidden: description: Whether this channel is hidden by current user or not title: Hidden type: boolean - x-stream-index: "026" + 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: "023" + x-stream-index: "019" id: description: Channel unique ID title: ID type: string - x-stream-index: "003" + 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: "006" + x-stream-index: "004" member_count: description: Number of members in the channel format: int32 title: Member count type: integer - x-stream-index: "015" + x-stream-index: "012" members: description: List of channel members (max 100) items: $ref: '#/components/schemas/ChannelMember' - title: Members + title: ChannelMembers type: array - x-stream-index: "014" + x-stream-index: "011" mute_expires_at: description: Date of mute expiration format: date-time title: Mute expires at type: string - x-stream-index: "019" + x-stream-index: "015" muted: description: Whether this channel is muted or not title: Muted type: boolean - x-stream-index: "018" + x-stream-index: "014" own_capabilities: description: List of channel capabilities of authenticated user items: - type: string - title: Own Capabilities + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability type: array - x-stream-index: "025" + x-stream-index: "021" team: description: Team the channel belongs to (multi-tenant only) title: Team type: string - x-stream-index: "020" + x-stream-index: "016" truncated_at: description: Date of the latest truncation of the channel format: date-time - title: Truncated At + title: UserResponse type: string - x-stream-index: "028" + x-stream-index: "024" truncated_by: - $ref: '#/components/schemas/UserObject' - x-stream-index: "029" + $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: "004" + x-stream-index: "002" updated_at: description: Date/time of the last update format: date-time title: Updated at type: string - x-stream-index: "009" + x-stream-index: "006" required: - id - type @@ -2943,6 +3131,7 @@ components: - rating type: object CollectUserFeedbackResponse: + description: Basic response information nullable: true properties: duration: @@ -2952,6 +3141,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Command: description: Represents custom chat command @@ -2998,6 +3188,56 @@ components: - 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" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + required: + - grants + - commands + type: object ConnectUserDetailsRequest: properties: custom: @@ -3020,7 +3260,7 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' @@ -3140,6 +3380,7 @@ components: x-stream-index: "004" type: object CreateDeviceRequest: + description: Create device request nullable: true properties: id: @@ -3172,6 +3413,7 @@ components: required: - id - push_provider + title: CreateDeviceRequest type: object CreateGuestRequest: nullable: true @@ -3271,6 +3513,7 @@ components: - id type: object DeleteCallRequest: + description: DeleteCallRequest is the payload for deleting a call. nullable: true properties: hard: @@ -3279,44 +3522,56 @@ components: 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: - description: Duration of the request in milliseconds - title: 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 - Device: + DeviceResponse: + description: Response for Device properties: created_at: description: Date/time of creation @@ -3364,7 +3619,7 @@ components: - id - created_at - user_id - title: Device + title: DeviceResponse type: object EdgeResponse: properties: @@ -3460,16 +3715,22 @@ components: - 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 EnrichedActivity: properties: @@ -3548,45 +3809,136 @@ components: x-stream-index: "005" id: type: string - x-stream-index: "001" - kind: + 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: + ban_count: + format: int32 + type: integer + x-stream-index: "002" + ban_expires: + format: date-time + type: string + x-stream-index: "001.016" + banned: + type: boolean + x-stream-index: "001.015" + created_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.007" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.005" + deactivated_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.013" + deleted_at: + format: date-time + readOnly: true + type: string + x-stream-index: "001.012" + 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.022" + language: + type: string + x-stream-index: "001.033" + last_active: + format: date-time + readOnly: true 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: + x-stream-index: "001.010" + last_engaged_at: + format: date-time + readOnly: true type: string - x-stream-index: "007" - target_feeds: + x-stream-index: "001.011" + online: + readOnly: true + type: boolean + x-stream-index: "001.021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "001.024" + revoke_tokens_issued_before: + format: date-time + type: string + x-stream-index: "001.040" + role: + type: string + x-stream-index: "001.004" + teams: items: type: string type: array - x-stream-index: "006" + x-stream-index: "001.034" updated_at: - $ref: '#/components/schemas/Time' - x-stream-index: "013" - user: - $ref: '#/components/schemas/Data' - x-stream-index: "011" - user_id: + format: date-time + readOnly: true type: string - x-stream-index: "004" + x-stream-index: "001.008" required: - - kind - - activity_id - - user_id + - id + - role + - custom + - banned + - online + - ban_count + - deleted_content_count type: object Field: nullable: true @@ -3656,7 +4008,7 @@ components: type: string x-stream-index: "018" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "006" required: - entity_type @@ -3758,8 +4110,10 @@ components: - own_capabilities - blocked_users - duration + title: GetCallResponse type: object GetCallStatsResponse: + description: Basic response information nullable: true properties: aggregated: @@ -3832,8 +4186,10 @@ components: - max_freezes_duration_seconds - sfus - participant_report + title: Response type: object GetEdgesResponse: + description: Basic response information nullable: true properties: duration: @@ -3849,6 +4205,7 @@ components: required: - edges - duration + title: Response type: object GetOrCreateCallRequest: nullable: true @@ -3876,6 +4233,7 @@ components: video: type: boolean x-stream-index: "006" + title: GetOrCreateCallRequest type: object GetOrCreateCallResponse: nullable: true @@ -3909,6 +4267,7 @@ components: - blocked_users - created - duration + title: GetOrCreateCallResponse type: object GoLiveRequest: nullable: true @@ -3931,8 +4290,10 @@ components: transcription_storage_name: type: string x-stream-index: "006" + title: GoLiveRequest type: object GoLiveResponse: + description: Basic response information nullable: true properties: call: @@ -3946,6 +4307,7 @@ components: required: - call - duration + title: Response type: object HLSSettingsRequest: properties: @@ -3964,18 +4326,23 @@ components: 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: @@ -3983,6 +4350,7 @@ components: - enabled - quality_tracks - layout + title: HLSSettingsResponse type: object HealthCheckEvent: nullable: true @@ -4128,6 +4496,7 @@ components: x-stream-index: "006" required: - location + title: JoinCallRequest type: object JoinCallResponse: nullable: true @@ -4171,19 +4540,24 @@ components: - 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 @@ -4235,12 +4609,13 @@ components: x-stream-index: "001" type: object ListDevicesResponse: + description: List devices response nullable: true properties: devices: description: List of devices items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "001" @@ -4250,8 +4625,10 @@ components: required: - devices - duration + title: ListDevicesResponse type: object ListRecordingsResponse: + description: Response for listing recordings nullable: true properties: duration: @@ -4260,11 +4637,13 @@ components: 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 @@ -4273,13 +4652,16 @@ components: 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 Location: properties: @@ -4318,6 +4700,7 @@ components: - video_subscribed type: object MemberRequest: + description: MemberRequest is the payload for adding a member to a call. properties: custom: additionalProperties: {} @@ -4336,8 +4719,10 @@ components: 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 @@ -4379,40 +4764,26 @@ components: - custom - created_at - updated_at + title: MemberResponse type: object Message: - 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: "011" before_message_send_failed: - description: Whether `before_message_send webhook` failed or not. Field - is only accessible in push webhook - title: Before Message Send Failed type: boolean - x-stream-docs-page-id: before_message_send_webhook x-stream-index: "045" cid: - description: Channel unique identifier in : format - title: Channel CID type: string x-stream-index: "027" command: - description: Contains provided slash command - title: Command type: string - x-stream-docs-page-id: custom_commands_webhook x-stream-index: "006" created_at: - description: Date/time of creation format: date-time - title: Created at type: string x-stream-index: "029" custom: @@ -4420,9 +4791,7 @@ components: type: object x-stream-index: "033" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: string x-stream-index: "032" deleted_reply_count: @@ -4430,23 +4799,14 @@ components: type: integer x-stream-index: "022" 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: "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: "043" id: - description: Message ID is unique string identifier of the message - title: ID type: string x-stream-index: "002" image_labels: @@ -4454,22 +4814,16 @@ components: items: type: string type: array - description: Contains image moderation information - title: Image moderation labels type: object x-stream-index: "039" latest_reactions: - description: List of 10 latest reactions to this message items: $ref: '#/components/schemas/Reaction' - title: Latest reactions type: array x-stream-index: "012" mentioned_users: - description: List of mentioned users items: - $ref: '#/components/schemas/UserObject' - title: Mentioned Users + $ref: '#/components/schemas/User' type: array x-stream-index: "042" message_text_updated_at: @@ -4477,77 +4831,46 @@ components: type: string x-stream-index: "051" 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: "005" own_reactions: - description: List of 10 latest reactions of authenticated user to this message items: $ref: '#/components/schemas/Reaction' - title: Own reactions type: array x-stream-index: "013" parent_id: - description: ID of parent message (thread) - title: Parent message ID type: string - x-stream-docs-page-id: threads x-stream-index: "018" 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: "050" pinned: - description: Whether message is pinned or not - title: Pinned type: boolean - x-stream-docs-page-id: pinned_messages x-stream-index: "046" 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: "047" pinned_by: - $ref: '#/components/schemas/UserObject' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages + $ref: '#/components/schemas/User' x-stream-index: "049" poll: $ref: '#/components/schemas/Poll' x-stream-index: "053" poll_id: - description: Identifier of the poll to include in the message - title: Poll ID type: string x-stream-index: "052" quoted_message: $ref: '#/components/schemas/Message' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message x-stream-index: "024" quoted_message_id: - title: ID of quoted message type: string - x-stream-docs-page-id: threads#quote-message x-stream-index: "023" 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: "014" reaction_groups: @@ -4559,70 +4882,38 @@ components: 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: "015" reply_count: - description: Number of replies to this message format: int32 - title: Reply count type: integer x-stream-index: "021" shadowed: - description: Whether the message was shadowed or not - title: Shadowed type: boolean - x-stream-docs-page-id: moderation#shadow-ban x-stream-index: "035" 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: "020" silent: - description: Whether message is silent or not - title: Silent type: boolean x-stream-index: "044" text: - description: Text of the message. Should be empty if `mml` is provided - title: Text type: string x-stream-index: "004" thread_participants: - description: List of users who participate in thread items: - $ref: '#/components/schemas/UserObject' - title: Thread participants + $ref: '#/components/schemas/User' type: array - x-stream-docs-page-id: threads#quote-message x-stream-index: "026" 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 + 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: "030" user: - $ref: '#/components/schemas/UserObject' - description: Sender of the message. Required when using server-side API - title: User object + $ref: '#/components/schemas/User' x-stream-index: "010" required: - id @@ -4645,9 +4936,7 @@ components: - mentioned_users - silent - pinned - title: Message type: object - x-stream-docs-page-id: send_message ModerationCustomActionEvent: properties: created_at: @@ -4665,7 +4954,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -4692,7 +4981,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -4719,7 +5008,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -4779,8 +5068,10 @@ components: 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: @@ -4790,6 +5081,7 @@ components: x-stream-index: "001.001" required: - duration + title: MuteUsersResponse type: object NoiseCancellationSettings: properties: @@ -4846,9 +5138,11 @@ components: - send-audio - send-video - start-broadcast-call + - start-closed-captions-call - start-record-call - start-transcription-call - stop-broadcast-call + - stop-closed-captions-call - stop-record-call - stop-transcription-call - update-call @@ -4890,7 +5184,7 @@ components: x-stream-index: "001.010" devices: items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "004" @@ -5025,6 +5319,7 @@ components: 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: @@ -5040,8 +5335,10 @@ components: required: - user_id - session_id + title: PinRequest type: object PinResponse: + description: Basic response information nullable: true properties: duration: @@ -5051,6 +5348,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Poll: properties: @@ -5074,7 +5372,7 @@ components: type: string x-stream-index: "021" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "020" created_by_id: type: string @@ -5202,7 +5500,7 @@ components: type: string x-stream-index: "011" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "009" user_id: type: string @@ -5323,6 +5621,7 @@ components: - id type: object QueryCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -5344,6 +5643,7 @@ components: required: - members - duration + title: Response type: object QueryCallStatsRequest: nullable: true @@ -5372,6 +5672,7 @@ components: x-stream-index: "002" type: object QueryCallStatsResponse: + description: Basic response information nullable: true properties: duration: @@ -5393,12 +5694,14 @@ components: required: - reports - duration + title: Response type: object QueryCallsRequest: nullable: true properties: filter_conditions: additionalProperties: {} + title: Filters type: object x-stream-index: "003" limit: @@ -5414,14 +5717,18 @@ components: 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 @@ -5446,8 +5753,10 @@ components: required: - calls - duration + title: QueryCallsResponse type: object RTMPBroadcastRequest: + description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. properties: layout: $ref: '#/components/schemas/LayoutSettingsRequest' @@ -5490,16 +5799,18 @@ components: 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: RTMP Ingress + title: RTMPIngress type: object RTMPSettingsRequest: properties: @@ -5522,29 +5833,31 @@ components: 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: - description: Represents user reaction to a message nullable: true properties: created_at: - description: Date/time of creation format: date-time readOnly: true - title: Created at type: string x-stream-index: "008" custom: @@ -5552,35 +5865,25 @@ components: type: object x-stream-index: "010" message_id: - description: ID of a message user reacted to - title: Message ID type: string x-stream-index: "003" score: - description: Reaction score. If not specified reaction has score of 1 format: int32 - title: Score type: integer x-stream-index: "007" type: - description: The type of reaction (e.g. 'like', 'laugh', 'wow') maxLength: 30 - title: Type type: string x-stream-index: "006" updated_at: - description: Date/time of the last update format: date-time readOnly: true - title: Updated at type: string x-stream-index: "009" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "005" user_id: - description: ID of a user who reacted to a message - title: User ID type: string x-stream-index: "004" required: @@ -5590,9 +5893,7 @@ components: - created_at - updated_at - custom - title: Reaction type: object - x-stream-docs-page-id: send_reaction ReactionGroupResponse: nullable: true properties: @@ -5642,14 +5943,14 @@ components: 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: @@ -5661,6 +5962,7 @@ components: - available - disabled - auto-on + title: Mode type: string x-stream-index: "002" quality: @@ -5679,16 +5981,21 @@ components: 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: @@ -5696,6 +6003,7 @@ components: - mode - quality - layout + title: RecordSettingsResponse type: object RejectCallRequest: nullable: true @@ -5705,15 +6013,19 @@ components: 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 RequestPermissionRequest: nullable: true @@ -5726,17 +6038,22 @@ components: 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: @@ -5746,6 +6063,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object ReviewQueueItem: properties: @@ -5753,28 +6071,28 @@ components: items: $ref: '#/components/schemas/ActionLog' type: array - x-stream-index: "027" + x-stream-index: "028" assigned_to: - $ref: '#/components/schemas/UserObject' - x-stream-index: "024" + $ref: '#/components/schemas/User' + x-stream-index: "025" bans: items: $ref: '#/components/schemas/Ban' type: array - x-stream-index: "025" + x-stream-index: "026" completed_at: $ref: '#/components/schemas/NullTime' - x-stream-index: "016" + x-stream-index: "017" content_changed: type: boolean - x-stream-index: "028" + x-stream-index: "029" created_at: format: date-time type: string x-stream-index: "004" entity_creator: - $ref: '#/components/schemas/UserObject' - x-stream-index: "023" + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "024" entity_id: type: string x-stream-index: "007" @@ -5783,15 +6101,15 @@ components: x-stream-index: "006" feeds_v2_activity: $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "029" + x-stream-index: "030" feeds_v2_reaction: $ref: '#/components/schemas/Reaction' - x-stream-index: "030" + x-stream-index: "031" flags: items: $ref: '#/components/schemas/Flag2' type: array - x-stream-index: "026" + x-stream-index: "027" has_image: type: boolean x-stream-index: "011" @@ -5808,10 +6126,10 @@ components: items: type: string type: array - x-stream-index: "017" + x-stream-index: "018" message: $ref: '#/components/schemas/Message' - x-stream-index: "022" + x-stream-index: "023" moderation_payload: $ref: '#/components/schemas/ModerationPayload' x-stream-index: "009" @@ -5820,19 +6138,24 @@ components: x-stream-index: "010" recommended_action: type: string - x-stream-index: "015" + x-stream-index: "016" reviewed_at: $ref: '#/components/schemas/NullTime' - x-stream-index: "019" + x-stream-index: "020" reviewed_by: type: string - x-stream-index: "020" + x-stream-index: "021" severity: format: int32 type: integer - x-stream-index: "018" + x-stream-index: "019" status: type: string + x-stream-index: "015" + teams: + items: + type: string + type: array x-stream-index: "014" updated_at: format: date-time @@ -5848,6 +6171,7 @@ components: - has_image - has_video - has_text + - teams - status - recommended_action - completed_at @@ -5967,6 +6291,7 @@ components: - access_request_enabled type: object SendCallEventRequest: + description: Send a call event to the other user nullable: true properties: custom: @@ -5974,15 +6299,19 @@ components: 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 @@ -6002,6 +6331,7 @@ components: - type type: object SendReactionResponse: + description: Basic response information nullable: true properties: duration: @@ -6015,6 +6345,7 @@ components: required: - reaction - duration + title: Response type: object SortParamRequest: nullable: true @@ -6032,25 +6363,44 @@ components: type: string x-stream-index: "001" type: object + StartClosedCaptionsRequest: + nullable: true + type: object + StartClosedCaptionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + 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: - description: Duration of the request in milliseconds - title: 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: @@ -6064,8 +6414,11 @@ components: 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: @@ -6075,6 +6428,7 @@ components: x-stream-index: "001.001" required: - duration + title: StartRTMPBroadcastsResponse type: object StartRecordingRequest: nullable: true @@ -6082,15 +6436,21 @@ components: 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 @@ -6098,15 +6458,19 @@ components: transcription_external_storage: type: string x-stream-index: "002" + title: StartTranscriptionRequest 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: @@ -6119,6 +6483,7 @@ components: type: object StopAllRTMPBroadcastsRequest: nullable: true + title: StopAllRTMPBroadcastsRequest type: object StopAllRTMPBroadcastsResponse: nullable: true @@ -6130,11 +6495,29 @@ components: x-stream-index: "001.001" required: - duration + title: StopAllRTMPBroadcastsResponse + type: object + StopClosedCaptionsRequest: + nullable: true + 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 StopHLSBroadcastingRequest: nullable: true type: object StopHLSBroadcastingResponse: + description: Basic response information nullable: true properties: duration: @@ -6144,29 +6527,35 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopLiveRequest: nullable: true + 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: - description: Duration of the request in milliseconds - title: 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: @@ -6176,11 +6565,13 @@ components: 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: @@ -6190,11 +6581,13 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopTranscriptionRequest: nullable: true type: object StopTranscriptionResponse: + description: Basic response information nullable: true properties: duration: @@ -6204,6 +6597,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Subsession: nullable: true @@ -6260,16 +6654,24 @@ components: - 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: @@ -6312,6 +6714,10 @@ components: TranscriptionSettingsRequest: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -6333,6 +6739,10 @@ components: TranscriptionSettingsResponse: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -6358,16 +6768,17 @@ components: 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: @@ -6377,8 +6788,10 @@ components: 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: @@ -6388,6 +6801,7 @@ components: x-stream-index: "001.001" required: - duration + title: UnblockUserResponse type: object UnblockedUserEvent: description: |- @@ -6423,6 +6837,7 @@ components: 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: @@ -6438,8 +6853,10 @@ components: required: - user_id - session_id + title: UnpinRequest type: object UnpinResponse: + description: UnpinResponse is the payload for unpinning a message. nullable: true properties: duration: @@ -6449,8 +6866,10 @@ components: x-stream-index: "001.001" required: - duration + title: UnpinResponse type: object UpdateCallMembersRequest: + description: Update call members nullable: true properties: remove_members: @@ -6469,8 +6888,10 @@ components: title: Update Members type: array x-stream-index: "004" + title: UpdateCallMembersRequest type: object UpdateCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -6486,8 +6907,10 @@ components: required: - duration - members + title: Response type: object UpdateCallRequest: + description: Request for updating a call nullable: true properties: custom: @@ -6507,9 +6930,10 @@ components: title: Starts At type: string x-stream-index: "005" + title: UpdateCallRequest type: object UpdateCallResponse: - description: Represents a call + description: Response for updating a call nullable: true properties: call: @@ -6537,7 +6961,7 @@ components: - own_capabilities - blocked_users - duration - title: Call + title: UpdateCallResponse type: object UpdateUserPermissionsRequest: nullable: true @@ -6559,6 +6983,7 @@ components: - user_id type: object UpdateUserPermissionsResponse: + description: Basic response information nullable: true properties: duration: @@ -6568,6 +6993,7 @@ components: 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, @@ -6609,6 +7035,87 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + User: + properties: + ban_expires: + format: date-time + type: string + x-stream-index: "016" + banned: + type: boolean + x-stream-index: "015" + created_at: + format: date-time + readOnly: true + type: string + x-stream-index: "007" + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + deactivated_at: + format: date-time + readOnly: true + type: string + x-stream-index: "013" + deleted_at: + format: date-time + readOnly: true + type: string + x-stream-index: "012" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "022" + language: + type: string + x-stream-index: "033" + last_active: + format: date-time + readOnly: true + type: string + x-stream-index: "010" + last_engaged_at: + format: date-time + readOnly: true + type: string + x-stream-index: "011" + online: + readOnly: true + type: boolean + x-stream-index: "021" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "025" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettings' + x-stream-index: "024" + revoke_tokens_issued_before: + format: date-time + type: string + x-stream-index: "040" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "034" + updated_at: + format: date-time + readOnly: true + type: string + x-stream-index: "008" + required: + - id + - role + - custom + - banned + - online + type: object UserBannedEvent: properties: channel_id: @@ -6625,7 +7132,7 @@ components: type: string x-stream-index: "008.002" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" expiration: format: date-time @@ -6645,7 +7152,7 @@ components: type: string x-stream-index: "008.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "007.001" required: - created_by @@ -6667,14 +7174,14 @@ components: type: string x-stream-index: "003.002" created_by: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" type: default: user.deactivated type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: - created_by @@ -6705,7 +7212,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001.001" required: - type @@ -6816,7 +7323,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -6831,19 +7338,23 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "003" + x-stream-index: "004" + id: + type: string + x-stream-index: "001" image: type: string - x-stream-index: "002" + x-stream-index: "003" name: type: string - x-stream-index: "001" + x-stream-index: "002" roles: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" required: + - id - name - image - custom @@ -6893,7 +7404,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - type @@ -6903,110 +7414,6 @@ components: x-stream-event-client-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - UserObject: - description: Represents chat user - properties: - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: string - x-stream-index: "015" - banned: - description: Whether a user is banned or not - title: Banned - type: boolean - x-stream-index: "014" - created_at: - description: Date/time of creation - format: date-time - readOnly: true - title: Created at - type: string - x-stream-index: "007" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - deactivated_at: - description: Date of deactivation - format: date-time - readOnly: true - title: Deactivated at - type: string - x-stream-index: "012" - deleted_at: - description: Date/time of deletion - format: date-time - readOnly: true - title: Deleted at - type: string - x-stream-index: "011" - id: - description: Unique user identifier - title: ID - type: string - x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "021" - language: - description: Preferred language of a user - title: Language - type: string - x-stream-index: "032" - last_active: - description: Date of last activity - format: date-time - readOnly: true - title: Last active - type: string - x-stream-index: "010" - online: - description: Whether a user online or not - readOnly: true - title: Online - type: boolean - x-stream-index: "020" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "024" - push_notifications: - $ref: '#/components/schemas/PushNotificationSettings' - x-stream-index: "023" - revoke_tokens_issued_before: - description: Revocation date for tokens - format: date-time - title: Revoke tokens issued before - type: string - x-stream-index: "039" - role: - description: Determines the set of user permissions - title: Role - type: string - x-stream-index: "004" - teams: - description: List of teams user is a part of - items: - type: string - title: Teams - type: array - x-stream-index: "033" - updated_at: - description: Date/time of the last update - format: date-time - readOnly: true - title: Updated at - type: string - x-stream-index: "008" - required: - - id - - role - - custom - - banned - - online - title: User object - type: object UserPresenceChangedEvent: properties: created_at: @@ -7018,7 +7425,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001.001" required: - type @@ -7039,7 +7446,7 @@ components: type: string x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -7050,6 +7457,7 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent UserRequest: + description: User request object properties: custom: additionalProperties: {} @@ -7077,15 +7485,17 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' x-stream-index: "010" required: - id + title: UserRequest type: object UserResponse: + description: User response object properties: banned: description: Whether a user is banned or not @@ -7189,6 +7599,7 @@ components: - shadow_banned - devices - invisible + title: UserResponse type: object UserSessionStats: properties: @@ -7434,7 +7845,7 @@ components: type: string x-stream-index: "005.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - shadow @@ -7467,7 +7878,7 @@ components: type: string x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserObject' + $ref: '#/components/schemas/User' x-stream-index: "001" required: - type @@ -7500,16 +7911,7 @@ components: - type - created_at type: object - VideoQuality: - properties: - resolution: - $ref: '#/components/schemas/VideoResolution' - x-stream-index: "002" - usage_type: - type: string - x-stream-index: "001" - type: object - VideoResolution: + VideoDimension: properties: height: type: integer @@ -7521,6 +7923,15 @@ components: - width - height type: object + VideoQuality: + properties: + resolution: + $ref: '#/components/schemas/VideoDimension' + x-stream-index: "002" + usage_type: + type: string + x-stream-index: "001" + type: object VideoSettingsRequest: properties: access_request_enabled: @@ -7572,6 +7983,7 @@ components: - camera_facing type: object WSAuthMessage: + description: Websocket auth message nullable: true properties: products: @@ -7589,6 +8001,7 @@ components: required: - user_details - token + title: WSAuthMessage type: object WSClientEvent: description: The discriminator object for all websocket client events, it maps @@ -7609,6 +8022,9 @@ components: 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' @@ -7663,6 +8079,9 @@ components: oneOf: - $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' @@ -7722,6 +8141,9 @@ components: 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' @@ -7775,6 +8197,9 @@ components: oneOf: - $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' @@ -7866,7 +8291,7 @@ components: type: apiKey info: title: Stream API - version: v133.1.0 + version: v137.0.0 openapi: 3.0.3 paths: /video/call/{type}/{id}: @@ -7937,7 +8362,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallResponse' - description: Successful response + description: GetCallResponse "400": content: application/json: @@ -7989,6 +8414,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallRequest' + description: UpdateCallRequest required: true responses: "200": @@ -7996,7 +8422,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallResponse' - description: Call + description: UpdateCallResponse "400": content: application/json: @@ -8058,6 +8484,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallRequest' + description: GetOrCreateCallRequest required: true responses: "201": @@ -8065,7 +8492,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallResponse' - description: Successful response + description: GetOrCreateCallResponse "400": content: application/json: @@ -8132,7 +8559,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteRecordingResponse' - description: Successful response + description: DeleteRecordingResponse "400": content: application/json: @@ -8199,7 +8626,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteTranscriptionResponse' - description: Successful response + description: DeleteTranscriptionResponse "400": content: application/json: @@ -8253,7 +8680,7 @@ paths: application/json: schema: $ref: '#/components/schemas/AcceptCallResponse' - description: Successful response + description: AcceptCallResponse "400": content: application/json: @@ -8306,6 +8733,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserRequest' + description: BlockUserRequest required: true responses: "201": @@ -8313,7 +8741,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserResponse' - description: Successful response + description: BlockUserResponse "400": content: application/json: @@ -8366,6 +8794,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallRequest' + description: DeleteCallRequest required: true responses: "201": @@ -8373,7 +8802,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallResponse' - description: Successful response + description: DeleteCallResponse "400": content: application/json: @@ -8424,6 +8853,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventRequest' + description: SendCallEventRequest required: true responses: "201": @@ -8431,7 +8861,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventResponse' - description: Successful response + description: SendCallEventResponse "400": content: application/json: @@ -8492,7 +8922,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CollectUserFeedbackResponse' - description: Successful response + description: Response "400": content: application/json: @@ -8545,6 +8975,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveRequest' + description: GoLiveRequest required: true responses: "201": @@ -8552,7 +8983,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveResponse' - description: Successful response + description: Response "400": content: application/json: @@ -8610,6 +9041,7 @@ paths: application/json: schema: $ref: '#/components/schemas/JoinCallRequest' + description: JoinCallRequest required: true responses: "201": @@ -8617,7 +9049,7 @@ paths: application/json: schema: $ref: '#/components/schemas/JoinCallResponse' - description: Successful response + description: JoinCallResponse "400": content: application/json: @@ -8671,7 +9103,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EndCallResponse' - description: Successful response + description: EndCallResponse "400": content: application/json: @@ -8728,6 +9160,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersRequest' + description: UpdateCallMembersRequest required: true responses: "201": @@ -8735,7 +9168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -8785,6 +9218,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersRequest' + description: MuteUsersRequest required: true responses: "201": @@ -8792,7 +9226,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersResponse' - description: Successful response + description: MuteUsersResponse "400": content: application/json: @@ -8838,6 +9272,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinRequest' + description: PinRequest required: true responses: "201": @@ -8845,7 +9280,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinResponse' - description: Successful response + description: Response "400": content: application/json: @@ -8901,7 +9336,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendReactionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -8948,7 +9383,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListRecordingsResponse' - description: Successful response + description: ListRecordingsResponse "400": content: application/json: @@ -9001,6 +9436,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RejectCallRequest' + description: RejectCallRequest required: true responses: "201": @@ -9008,7 +9444,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RejectCallResponse' - description: Successful response + description: RejectCallResponse "400": content: application/json: @@ -9058,6 +9494,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RequestPermissionRequest' + description: RequestPermissionRequest required: true responses: "201": @@ -9065,7 +9502,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RequestPermissionResponse' - description: Successful response + description: RequestPermissionResponse "400": content: application/json: @@ -9115,6 +9552,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsRequest' + description: StartRTMPBroadcastsRequest required: true responses: "201": @@ -9122,7 +9560,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsResponse' - description: Successful response + description: StartRTMPBroadcastsResponse "400": content: application/json: @@ -9179,6 +9617,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsRequest' + description: StopRTMPBroadcastsRequest required: true responses: "201": @@ -9186,7 +9625,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9237,7 +9676,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopAllRTMPBroadcastsResponse' - description: Successful response + description: StopAllRTMPBroadcastsResponse "400": content: application/json: @@ -9288,7 +9727,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartHLSBroadcastingResponse' - description: Successful response + description: StartHLSBroadcastingResponse "400": content: application/json: @@ -9304,6 +9743,57 @@ paths: summary: Start HLS broadcasting tags: - product:video + /video/call/{type}/{id}/start_closed_captions: + post: + description: | + Starts closed captions + + Required permissions: + - StartClosedCaptions + 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" + 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_recording: post: description: | @@ -9341,6 +9831,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingRequest' + description: StartRecordingRequest required: true responses: "201": @@ -9348,7 +9839,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingResponse' - description: Successful response + description: StartRecordingResponse "400": content: application/json: @@ -9398,6 +9889,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionRequest' + description: StartTranscriptionRequest required: true responses: "201": @@ -9405,7 +9897,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionResponse' - description: Successful response + description: StartTranscriptionResponse "400": content: application/json: @@ -9460,7 +9952,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9507,7 +9999,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopHLSBroadcastingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9523,6 +10015,56 @@ paths: summary: Stop HLS broadcasting tags: - product:video + /video/call/{type}/{id}/stop_closed_captions: + post: + description: | + Stops closed captions + + Sends events: + - call.transcription_stopped + + Required permissions: + - StopClosedCaptions + 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" + 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_live: post: description: |2 @@ -9561,7 +10103,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopLiveResponse' - description: Successful response + description: StopLiveResponse "400": content: application/json: @@ -9611,7 +10153,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRecordingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9661,7 +10203,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopTranscriptionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9690,7 +10232,9 @@ paths: name: type required: true schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true x-stream-index: "001.001" @@ -9698,7 +10242,9 @@ paths: name: id required: true schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true x-stream-index: "001.002" @@ -9708,7 +10254,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListTranscriptionsResponse' - description: Successful response + description: ListTranscriptionsResponse "400": content: application/json: @@ -9759,6 +10305,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserRequest' + description: UnblockUserRequest required: true responses: "201": @@ -9766,7 +10313,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserResponse' - description: Successful response + description: UnblockUserResponse "400": content: application/json: @@ -9812,6 +10359,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinRequest' + description: UnpinRequest required: true responses: "201": @@ -9819,7 +10367,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinResponse' - description: Successful response + description: UnpinResponse "400": content: application/json: @@ -9875,7 +10423,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateUserPermissionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9911,7 +10459,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9947,7 +10495,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -9983,6 +10531,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsRequest' + description: QueryCallsRequest required: true responses: "201": @@ -9990,7 +10539,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsResponse' - description: Successful response + description: QueryCallsResponse "400": content: application/json: @@ -10027,7 +10576,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -10053,7 +10602,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListDevicesResponse' - description: Successful response + description: ListDevicesResponse "400": content: application/json: @@ -10078,6 +10627,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": @@ -10085,7 +10635,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -10112,7 +10662,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetEdgesResponse' - description: Successful response + description: Response "400": content: application/json: diff --git a/openapi/video-openapi.json b/openapi/video-openapi.json index c8368219..ae14309b 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"},"title":{"type":"string","x-stream-index":"001"}},"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"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":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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":{"nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"BlockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"type":"object"},"CallEvent":{"nullable":true,"properties":{"additional":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal"],"type":"object"},"CallIngressResponse":{"properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","x-stream-index":"001"}},"required":["rtmp"],"title":"Call inputs","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"},"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"},"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"],"type":"object"},"CallRequest":{"properties":{"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"}},"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"015"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"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":"020"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"string","x-stream-index":"013"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"018"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"022"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"019"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"016"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"014"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"021"},"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","backstage","settings","blocked_user_ids","ingress","egress"],"title":"Call","type":"object"},"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"},"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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"type":"object"},"CallStateResponseFields":{"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"],"type":"object"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"type":"object"},"CallTypeResponse":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"external_storage":{"type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"type":"object"},"CheckExternalStorageResponse":{"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"],"type":"object"},"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":["user_session_id","sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"type":"object"},"CreateCallTypeRequest":{"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"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"required":["name"],"type":"object"},"CreateCallTypeResponse":{"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"],"type":"object"},"CreateDeviceRequest":{"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"],"type":"object"},"CreateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"type":"object"},"CreateExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"DeleteCallRequest":{"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"}},"type":"object"},"DeleteCallResponse":{"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":"003.001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["call","duration"],"type":"object"},"DeleteExternalStorageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"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":"Device","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"}},"required":["playlist_url"],"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"},"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":{"nullable":true,"type":"object"},"EndCallResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"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"},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"],"type":"object"},"GetCallStatsResponse":{"nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"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"],"type":"object"},"GetEdgesResponse":{"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"],"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"}},"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"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"type":"object"},"GoLiveResponse":{"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"],"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"],"type":"object"},"HLSSettingsResponse":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"type":"object"},"LayoutSettingsRequest":{"properties":{"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"ListCallTypeResponse":{"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"],"type":"object"},"ListDevicesResponse":{"nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/Device"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"type":"object"},"ListExternalStorageResponse":{"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"],"type":"object"},"ListRecordingsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"items":{"$ref":"#/components/schemas/CallTranscription"},"type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"type":"object"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"type":"object"},"MemberRequest":{"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"],"type":"object"},"MemberResponse":{"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"],"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"}},"type":"object"},"MuteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"PinRequest":{"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"],"type":"object"},"PinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["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"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"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":{"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"],"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":{"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"],"type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"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":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"004"}},"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"],"type":"object"},"RTMPBroadcastRequest":{"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"],"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMP Ingress","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"}},"type":"object"},"RTMPSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"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"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"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"],"type":"object"},"RecordSettingsResponse":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"type":"object"},"Response":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"S3Request":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"type":"object"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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":{"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"}},"type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["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"},"StartHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StartHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"playlist_url":{"type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"type":"object"},"StartRTMPBroadcastsRequest":{"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"],"type":"object"},"StartRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartRecordingResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"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"],"type":"object"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopLiveRequest":{"nullable":true,"type":"object"},"StopLiveResponse":{"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"],"type":"object"},"StopRTMPBroadcastsRequest":{"nullable":true,"type":"object"},"StopRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StopTranscriptionRequest":{"nullable":true,"type":"object"},"StopTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"type":"object"},"UnblockUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnpinRequest":{"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"],"type":"object"},"UnpinResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UpdateCallMembersRequest":{"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"}},"type":"object"},"UpdateCallMembersResponse":{"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"],"type":"object"},"UpdateCallRequest":{"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"}},"type":"object"},"UpdateCallResponse":{"description":"Represents 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":"Call","type":"object"},"UpdateCallTypeRequest":{"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"}},"type":"object"},"UpdateCallTypeResponse":{"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"],"type":"object"},"UpdateExternalStorageRequest":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"type":"object"},"UpdateExternalStorageResponse":{"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"],"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":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"image":{"type":"string","x-stream-index":"002"},"name":{"type":"string","x-stream-index":"001"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"004"}},"required":["name","image","custom","roles"],"type":"object"},"UserRequest":{"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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/PrivacySettings","x-stream-index":"007"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"type":"object"},"UserResponse":{"properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/Device"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoResolution","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"VideoResolution":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"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"}},"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":"v133.1.0"},"openapi":"3.0.3","paths":{"/video/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCallStats\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"Call"},"400":{"content":{"application/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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- DeleteCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- SendEvent\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"Successful response"},"400":{"content":{"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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCall\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- EndCall\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"description":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- MuteUsers\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"Successful response"},"400":{"content":{"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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListRecordings\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":"Successful response"},"400":{"content":{"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}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n\nRequired permissions:\n- StartBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopBroadcasting\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartBroadcasting\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":"Successful response"},"400":{"content":{"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StartTranscription\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":"Successful response"},"400":{"content":{"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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":"Successful response"},"400":{"content":{"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopRecording\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":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- StopTranscription\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"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- ListTranscriptions\n","operationId":"ListTranscriptions","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/ListTranscriptionsResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- BlockUser\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- PinCallTrack\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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"Successful response"},"400":{"content":{"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\nRequired permissions:\n- UpdateCallPermissions\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteRecording\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- DeleteTranscription\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":"Successful response"},"400":{"content":{"application/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\nRequired permissions:\n- ReadCall\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"application/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"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"description":"Successful response"},"400":{"content":{"application/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":"Successful response"},"400":{"content":{"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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://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"},"title":{"type":"string","x-stream-index":"001"}},"type":"object"},"AggregatedStats":{"properties":{"countrywise_aggregate_stats":{"additionalProperties":{"$ref":"#/components/schemas/CountrywiseAggregateStats"},"type":"object","x-stream-index":"003"},"publisher_aggregate_stats":{"$ref":"#/components/schemas/PublisherAggregateStats","x-stream-index":"002"},"turn":{"$ref":"#/components/schemas/TURNAggregatedStats","x-stream-index":"001"}},"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":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"001"},"abs_client_id":{"type":"string","x-stream-index":"003"},"abs_client_secret":{"type":"string","x-stream-index":"004"},"abs_tenant_id":{"type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"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"},"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"},"CallEvent":{"nullable":true,"properties":{"category":{"type":"string","x-stream-index":"009"},"component":{"type":"string","x-stream-index":"007"},"description":{"type":"string","x-stream-index":"004"},"end_timestamp":{"format":"int32","type":"integer","x-stream-index":"002"},"internal":{"type":"boolean","x-stream-index":"006"},"issue_tags":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"kind":{"type":"string","x-stream-index":"008"},"severity":{"format":"int32","type":"integer","x-stream-index":"003"},"timestamp":{"format":"int32","type":"integer","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"005"}},"required":["timestamp","end_timestamp","severity","description","type","internal","kind"],"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"},"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"},"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"},"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"],"title":"CallRecording","type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"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"},"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"},"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"},"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":"009"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"008"},"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"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"011"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"006"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"007"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"010"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"008"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"009"}},"required":["audio","backstage","broadcasting","geofencing","recording","ring","screensharing","transcription","video","thumbnails","limits"],"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"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"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":"006"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"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"},"CallTimeline":{"properties":{"events":{"items":{"$ref":"#/components/schemas/CallEvent"},"type":"array","x-stream-index":"001"}},"required":["events"],"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"},"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"],"title":"CallTranscription","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":"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"},"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"},"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":["user_session_id","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"},"Coordinates":{"properties":{"latitude":{"format":"float","type":"number","x-stream-index":"001"},"longitude":{"format":"float","type":"number","x-stream-index":"002"}},"required":["latitude","longitude"],"type":"object"},"Count":{"properties":{"approximate":{"type":"boolean","x-stream-index":"002"},"value":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["value","approximate"],"type":"object"},"CountrywiseAggregateStats":{"nullable":true,"properties":{"participant_count":{"$ref":"#/components/schemas/Count","x-stream-index":"001"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"005"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"004"}},"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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"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"},"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"},"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"}},"required":["playlist_url"],"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"},"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"}},"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"},"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"},"GeolocationResult":{"properties":{"accuracy_radius":{"format":"int32","type":"integer","x-stream-index":"004"},"city":{"type":"string","x-stream-index":"003.001"},"continent":{"type":"string","x-stream-index":"003.004"},"continent_code":{"type":"string","x-stream-index":"002.003"},"country":{"type":"string","x-stream-index":"003.003"},"country_iso_code":{"type":"string","x-stream-index":"002.002"},"latitude":{"format":"float","type":"number","x-stream-index":"001.001"},"longitude":{"format":"float","type":"number","x-stream-index":"001.002"},"subdivision":{"type":"string","x-stream-index":"003.002"},"subdivision_iso_code":{"type":"string","x-stream-index":"002.001"}},"required":["latitude","longitude","subdivision_iso_code","country_iso_code","continent_code","city","subdivision","country","continent","accuracy_radius"],"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"},"GetCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"aggregated":{"$ref":"#/components/schemas/AggregatedStats","x-stream-index":"005"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"call_status":{"type":"string","x-stream-index":"002"},"call_timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"014"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"006"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"007"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"012"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"008"},"max_total_quality_limitation_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"011"},"participant_report":{"items":{"$ref":"#/components/schemas/UserStats"},"type":"array","x-stream-index":"015"},"publishing_participants":{"format":"int32","type":"integer","x-stream-index":"009"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"004"},"sfu_count":{"format":"int32","type":"integer","x-stream-index":"010"},"sfus":{"items":{"$ref":"#/components/schemas/SFULocationResponse"},"type":"array","x-stream-index":"013"}},"required":["duration","call_status","call_duration_seconds","quality_score","max_participants","publishing_participants","sfu_count","max_total_quality_limitation_duration_seconds","max_freezes_duration_seconds","sfus","participant_report"],"title":"Response","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_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_rtmp_broadcasts":{"type":"boolean","x-stream-index":"008"},"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"},"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"},"LayoutSettingsRequest":{"properties":{"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":{"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":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"}},"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"},"Location":{"properties":{"continent_code":{"type":"string","x-stream-index":"003"},"country_iso_code":{"type":"string","x-stream-index":"002"},"subdivision_iso_code":{"type":"string","x-stream-index":"001"}},"required":["subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"MediaPubSubHint":{"properties":{"audio_published":{"type":"boolean","x-stream-index":"001"},"audio_subscribed":{"type":"boolean","x-stream-index":"002"},"video_published":{"type":"boolean","x-stream-index":"003"},"video_subscribed":{"type":"boolean","x-stream-index":"004"}},"required":["audio_published","audio_subscribed","video_published","video_subscribed"],"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"},"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"},"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"},"NullBool":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"type":"boolean","writeOnly":true,"x-stream-index":"001"}},"type":"object"},"NullTime":{"properties":{"HasValue":{"type":"boolean","writeOnly":true,"x-stream-index":"002"},"Value":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"001"}},"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-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"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"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublishedTrackInfo":{"properties":{"codec_mime_type":{"type":"string","x-stream-index":"003"},"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"type":"object"},"PublisherAggregateStats":{"properties":{"by_track_type":{"additionalProperties":{"$ref":"#/components/schemas/Count"},"type":"object","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsInput":{"properties":{"disabled":{"$ref":"#/components/schemas/NullBool","x-stream-index":"001"},"disabled_until":{"$ref":"#/components/schemas/NullTime","x-stream-index":"002"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"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"},"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"},"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"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"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"},"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":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","maximum":180000,"minimum":5000,"type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_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"},"S3Request":{"properties":{"s3_api_key":{"type":"string","x-stream-index":"002"},"s3_region":{"type":"string","x-stream-index":"001"},"s3_secret":{"type":"string","x-stream-index":"003"}},"required":["s3_region"],"type":"object"},"SFULocationResponse":{"properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates","x-stream-index":"004"},"datacenter":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"location":{"$ref":"#/components/schemas/Location","x-stream-index":"003"}},"required":["id","datacenter","location","coordinates"],"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"},"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,"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"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":{"transcription_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartTranscriptionRequest","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,"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"},"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,"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,"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"},"Subsession":{"nullable":true,"properties":{"ended_at":{"format":"int32","type":"integer","x-stream-index":"002"},"joined_at":{"format":"int32","type":"integer","x-stream-index":"001"},"pub_sub_hint":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"004"},"sfu_id":{"type":"string","x-stream-index":"003"}},"required":["joined_at","ended_at","sfu_id"],"type":"object"},"TURNAggregatedStats":{"properties":{"tcp":{"$ref":"#/components/schemas/Count","x-stream-index":"002"},"total":{"$ref":"#/components/schemas/Count","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"},"TimeStats":{"properties":{"average_seconds":{"format":"float","type":"number","x-stream-index":"001"},"max_seconds":{"format":"float","type":"number","x-stream-index":"002"}},"required":["average_seconds","max_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"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"},"languages":{"items":{"type":"string"},"maximum":2,"type":"array","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages"],"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"},"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":{"nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","x-stream-index":"003.006"},"bucket":{"type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"type":"string","x-stream-index":"003.003"},"storage_type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"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"},"UserInfoResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"002"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"005"}},"required":["id","name","image","custom","roles"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"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"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsInput","x-stream-index":"010"},"role":{"title":"Role","type":"string","x-stream-index":"008"},"teams":{"items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"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.011"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"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.015"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.010"},"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.013"},"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.012"},"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.014"},"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"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","devices","invisible"],"title":"UserResponse","type":"object"},"UserSessionStats":{"properties":{"browser":{"type":"string","x-stream-index":"014.008"},"browser_version":{"type":"string","x-stream-index":"014.009"},"current_ip":{"type":"string","x-stream-index":"006"},"current_sfu":{"type":"string","x-stream-index":"007"},"device_model":{"type":"string","x-stream-index":"014.006"},"device_version":{"type":"string","x-stream-index":"014.007"},"distance_to_sfu_kilometers":{"format":"float","type":"number","x-stream-index":"008"},"freeze_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.011"},"geolocation":{"$ref":"#/components/schemas/GeolocationResult","x-stream-index":"009"},"group":{"type":"string","x-stream-index":"014.010"},"jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"003"},"max_fir_per_second":{"format":"float","type":"number","x-stream-index":"016.003"},"max_freeze_fraction":{"format":"float","type":"number","x-stream-index":"016.006"},"max_freezes_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.005"},"max_freezes_per_second":{"format":"float","type":"number","x-stream-index":"016.004"},"max_nack_per_second":{"format":"float","type":"number","x-stream-index":"016.002"},"max_pli_per_second":{"format":"float","type":"number","x-stream-index":"016.001"},"max_publishing_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"015.003"},"max_receiving_video_quality":{"$ref":"#/components/schemas/VideoQuality","x-stream-index":"016.012"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"005"},"os":{"type":"string","x-stream-index":"014.001"},"os_version":{"type":"string","x-stream-index":"014.002"},"packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"016.007"},"pub_sub_hints":{"$ref":"#/components/schemas/MediaPubSubHint","x-stream-index":"012"},"published_tracks":{"items":{"$ref":"#/components/schemas/PublishedTrackInfo"},"type":"array","x-stream-index":"015.002"},"publisher_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.009"},"publisher_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"015.008"},"publisher_noise_cancellation_seconds":{"format":"float","type":"number","x-stream-index":"015.012"},"publisher_packet_loss_fraction":{"format":"float","type":"number","x-stream-index":"015.007"},"publisher_quality_limitation_fraction":{"format":"float","type":"number","x-stream-index":"015.011"},"publisher_video_quality_limitation_duration_seconds":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"015.010"},"publishing_audio_codec":{"type":"string","x-stream-index":"015.005"},"publishing_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"015.001"},"publishing_video_codec":{"type":"string","x-stream-index":"015.006"},"quality_score":{"format":"float","type":"number","x-stream-index":"004"},"receiving_audio_codec":{"type":"string","x-stream-index":"016.014"},"receiving_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"016.010"},"receiving_video_codec":{"type":"string","x-stream-index":"016.015"},"sdk":{"type":"string","x-stream-index":"014.004"},"sdk_version":{"type":"string","x-stream-index":"014.005"},"session_id":{"type":"string","x-stream-index":"011"},"subscriber_jitter":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.009"},"subscriber_latency":{"$ref":"#/components/schemas/TimeStats","x-stream-index":"016.008"},"subscriber_video_quality_throttled_duration_seconds":{"format":"float","type":"number","x-stream-index":"016.016"},"subsessions":{"items":{"$ref":"#/components/schemas/Subsession"},"type":"array","x-stream-index":"010"},"timeline":{"$ref":"#/components/schemas/CallTimeline","x-stream-index":"001"},"total_pixels_in":{"type":"integer","x-stream-index":"016.013"},"total_pixels_out":{"type":"integer","x-stream-index":"015.004"},"truncated":{"type":"boolean","x-stream-index":"013"},"webrtc_version":{"type":"string","x-stream-index":"014.003"}},"required":["quality_score","min_event_ts","session_id","group","publishing_duration_seconds","total_pixels_out","publisher_packet_loss_fraction","max_freezes_duration_seconds","max_freeze_fraction","packet_loss_fraction","receiving_duration_seconds","freeze_duration_seconds","total_pixels_in"],"type":"object"},"UserStats":{"nullable":true,"properties":{"info":{"$ref":"#/components/schemas/UserInfoResponse","x-stream-index":"001"},"min_event_ts":{"format":"int32","type":"integer","x-stream-index":"004"},"rating":{"format":"int32","type":"integer","x-stream-index":"003"},"session_stats":{"items":{"$ref":"#/components/schemas/UserSessionStats"},"type":"array","x-stream-index":"002"}},"required":["info","session_stats","min_event_ts"],"type":"object"},"VideoDimension":{"properties":{"height":{"type":"integer","x-stream-index":"002"},"width":{"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"VideoQuality":{"properties":{"resolution":{"$ref":"#/components/schemas/VideoDimension","x-stream-index":"002"},"usage_type":{"type":"string","x-stream-index":"001"}},"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"}},"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":"v137.0.0"},"openapi":"3.0.3","paths":{"/video/call/members":{"post":{"description":"Query call members with filter query\n\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- ReadCallStats\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\nRequired permissions:\n- ReadCall\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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- CreateCall\n- ReadCall\n- UpdateCallSettings\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- DeleteCall\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\nRequired permissions:\n- SendEvent\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/{session}":{"post":{"description":"\n\nRequired permissions:\n- JoinCall\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"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"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\nRequired permissions:\n- UpdateCall\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\nRequired permissions:\n- EndCall\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\nRequired permissions:\n- RemoveCallMember\n- UpdateCallMember\n- UpdateCallMemberRole\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\nRequired permissions:\n- MuteUsers\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}/pin":{"post":{"description":"Pins a track for all users in the call.\n\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- ListRecordings\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}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StartBroadcasting\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\nRequired permissions:\n- StartClosedCaptions\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"}}],"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_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n\nRequired permissions:\n- StartRecording\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\nRequired permissions:\n- StartTranscription\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"}}},"description":"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}/stats/{session}":{"get":{"description":"\n\nRequired permissions:\n- ReadCallStats\n","operationId":"GetCallStats","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":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallStatsResponse"}}},"description":"Response"},"400":{"content":{"application/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 Stats","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n\nRequired permissions:\n- StopBroadcasting\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\nRequired permissions:\n- StopClosedCaptions\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"}}],"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_live":{"post":{"description":"\n\nSends events:\n- call.updated\n\nRequired permissions:\n- UpdateCall\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"}}],"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\nRequired permissions:\n- StopRecording\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\nRequired permissions:\n- StopTranscription\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"}}],"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\nRequired permissions:\n- ListTranscriptions\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\nRequired permissions:\n- BlockUser\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\nRequired permissions:\n- PinCallTrack\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\nRequired permissions:\n- UpdateCallPermissions\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\nRequired permissions:\n- DeleteRecording\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\nRequired permissions:\n- DeleteTranscription\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\nRequired permissions:\n- ReadCall\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"}}},"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"}}},"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"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml index 4147bea9..82b14cbd 100644 --- a/openapi/video-openapi.yaml +++ b/openapi/video-openapi.yaml @@ -189,6 +189,7 @@ components: - enabled type: object BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. nullable: true properties: user_id: @@ -198,8 +199,10 @@ components: 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: @@ -209,6 +212,7 @@ components: x-stream-index: "001.001" required: - duration + title: BlockUserResponse type: object BroadcastSettingsRequest: properties: @@ -223,28 +227,32 @@ components: 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 CallEvent: nullable: true properties: - additional: - additionalProperties: {} - type: object - x-stream-index: "008" + category: + type: string + x-stream-index: "009" component: type: string x-stream-index: "007" @@ -258,6 +266,14 @@ components: internal: type: boolean x-stream-index: "006" + issue_tags: + items: + type: string + type: array + x-stream-index: "010" + kind: + type: string + x-stream-index: "008" severity: format: int32 type: integer @@ -276,15 +292,18 @@ components: - description - type - internal + - kind 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: Call inputs + title: CallIngressResponse type: object CallParticipantResponse: properties: @@ -333,8 +352,10 @@ components: - url - start_time - end_time + title: CallRecording type: object CallRequest: + description: CallRequest is the payload for creating a call. properties: created_by: $ref: '#/components/schemas/UserRequest' @@ -367,18 +388,22 @@ components: video: type: boolean x-stream-index: "008" + title: CallRequest type: object CallResponse: description: Represents a call properties: backstage: type: boolean - x-stream-index: "015" + x-stream-index: "016" blocked_user_ids: items: type: string type: array - x-stream-index: "017" + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" cid: description: The unique identifier for a call (:) title: CID @@ -406,13 +431,13 @@ components: x-stream-index: "008" egress: $ref: '#/components/schemas/EgressResponse' - x-stream-index: "020" + x-stream-index: "021" ended_at: description: Date/time when the call ended format: date-time title: Ended At type: string - x-stream-index: "013" + x-stream-index: "014" id: description: Call ID title: ID @@ -420,32 +445,32 @@ components: x-stream-index: "003" ingress: $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "018" + x-stream-index: "019" join_ahead_time_seconds: format: int32 type: integer - x-stream-index: "022" + x-stream-index: "023" recording: type: boolean x-stream-index: "011" session: $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "019" + x-stream-index: "020" settings: $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "016" + 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: "014" + x-stream-index: "015" team: type: string x-stream-index: "006" thumbnails: $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "021" + x-stream-index: "022" transcribing: type: boolean x-stream-index: "012" @@ -471,12 +496,13 @@ components: - updated_at - recording - transcribing + - captioning - backstage - settings - blocked_user_ids - ingress - egress - title: Call + title: CallResponse type: object CallSessionResponse: properties: @@ -630,6 +656,7 @@ components: - limits type: object CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response properties: call: $ref: '#/components/schemas/CallResponse' @@ -651,6 +678,7 @@ components: - members - own_capabilities - blocked_users + title: CallStateResponseFields type: object CallStatsReportSummaryResponse: properties: @@ -722,14 +750,20 @@ components: - url - start_time - end_time + title: CallTranscription 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: string x-stream-index: "005" external_storage: + description: the external storage for the call type + title: ExternalStorage type: string x-stream-index: "007" grants: @@ -737,19 +771,29 @@ components: 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: @@ -759,8 +803,10 @@ components: - notification_settings - created_at - updated_at + title: CallTypeResponse type: object CheckExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -774,6 +820,7 @@ components: required: - duration - file_url + title: Response type: object CollectUserFeedbackRequest: nullable: true @@ -811,6 +858,7 @@ components: - rating type: object CollectUserFeedbackResponse: + description: Basic response information nullable: true properties: duration: @@ -820,6 +868,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Coordinates: properties: @@ -868,9 +917,12 @@ components: x-stream-index: "004" 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: @@ -878,6 +930,8 @@ components: items: type: string type: array + description: the permissions granted to each role + title: Grants type: object x-stream-index: "002.001" name: @@ -885,24 +939,34 @@ components: 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: @@ -910,19 +974,29 @@ components: 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: @@ -933,8 +1007,10 @@ components: - created_at - updated_at - duration + title: CreateCallTypeResponse type: object CreateDeviceRequest: + description: Create device request nullable: true properties: id: @@ -975,6 +1051,7 @@ components: required: - id - push_provider + title: CreateDeviceRequest type: object CreateExternalStorageRequest: nullable: true @@ -1010,6 +1087,7 @@ components: - bucket type: object CreateExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -1019,6 +1097,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object CreateGuestRequest: nullable: true @@ -1055,6 +1134,7 @@ components: - duration type: object DeleteCallRequest: + description: DeleteCallRequest is the payload for deleting a call. nullable: true properties: hard: @@ -1063,26 +1143,30 @@ components: 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: - description: Duration of the request in milliseconds - title: 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: @@ -1092,26 +1176,36 @@ components: 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 - Device: + DeviceResponse: + description: Response for Device nullable: true properties: created_at: @@ -1160,7 +1254,7 @@ components: - id - created_at - user_id - title: Device + title: DeviceResponse type: object EdgeResponse: properties: @@ -1256,16 +1350,22 @@ components: - 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: @@ -1390,8 +1490,10 @@ components: - own_capabilities - blocked_users - duration + title: GetCallResponse type: object GetCallStatsResponse: + description: Basic response information nullable: true properties: aggregated: @@ -1464,6 +1566,7 @@ components: - max_freezes_duration_seconds - sfus - participant_report + title: Response type: object GetCallTypeResponse: nullable: true @@ -1506,8 +1609,10 @@ components: - created_at - updated_at - duration + title: GetCallTypeResponse type: object GetEdgesResponse: + description: Basic response information nullable: true properties: duration: @@ -1523,6 +1628,7 @@ components: required: - edges - duration + title: Response type: object GetOrCreateCallRequest: nullable: true @@ -1550,6 +1656,7 @@ components: video: type: boolean x-stream-index: "006" + title: GetOrCreateCallRequest type: object GetOrCreateCallResponse: nullable: true @@ -1580,6 +1687,7 @@ components: - blocked_users - created - duration + title: GetOrCreateCallResponse type: object GoLiveRequest: nullable: true @@ -1602,8 +1710,10 @@ components: transcription_storage_name: type: string x-stream-index: "006" + title: GoLiveRequest type: object GoLiveResponse: + description: Basic response information nullable: true properties: call: @@ -1617,6 +1727,7 @@ components: required: - call - duration + title: Response type: object HLSSettingsRequest: properties: @@ -1639,13 +1750,17 @@ components: 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: @@ -1655,6 +1770,7 @@ components: quality_tracks: items: type: string + title: Quality Tracks type: array x-stream-index: "003" required: @@ -1662,6 +1778,7 @@ components: - enabled - quality_tracks - layout + title: HLSSettingsResponse type: object LayoutSettingsRequest: properties: @@ -1737,6 +1854,7 @@ components: x-stream-index: "001" type: object ListCallTypeResponse: + description: Response for ListCallType nullable: true properties: call_types: @@ -1750,14 +1868,16 @@ components: 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/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "001" @@ -1767,8 +1887,10 @@ components: required: - devices - duration + title: ListDevicesResponse type: object ListExternalStorageResponse: + description: Basic response information nullable: true properties: duration: @@ -1784,8 +1906,10 @@ components: required: - duration - external_storages + title: Response type: object ListRecordingsResponse: + description: Response for listing recordings nullable: true properties: duration: @@ -1794,11 +1918,13 @@ components: 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 @@ -1807,13 +1933,16 @@ components: 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 Location: properties: @@ -1852,6 +1981,7 @@ components: - video_subscribed type: object MemberRequest: + description: MemberRequest is the payload for adding a member to a call. properties: custom: additionalProperties: {} @@ -1870,8 +2000,10 @@ components: 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 @@ -1913,6 +2045,7 @@ components: - custom - created_at - updated_at + title: MemberResponse type: object MuteUsersRequest: nullable: true @@ -1948,8 +2081,10 @@ components: 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: @@ -1959,6 +2094,7 @@ components: x-stream-index: "001.001" required: - duration + title: MuteUsersResponse type: object NoiseCancellationSettings: properties: @@ -2036,9 +2172,11 @@ components: - send-audio - send-video - start-broadcast-call + - start-closed-captions-call - start-record-call - start-transcription-call - stop-broadcast-call + - stop-closed-captions-call - stop-record-call - stop-transcription-call - update-call @@ -2048,6 +2186,7 @@ components: title: OwnCapability type: string PinRequest: + description: PinRequest is the payload for pinning a message. nullable: true properties: session_id: @@ -2063,8 +2202,10 @@ components: required: - user_id - session_id + title: PinRequest type: object PinResponse: + description: Basic response information nullable: true properties: duration: @@ -2074,15 +2215,7 @@ components: x-stream-index: "001.001" required: - 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" + title: Response type: object PrivacySettingsResponse: properties: @@ -2174,6 +2307,7 @@ components: - id type: object QueryCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -2195,6 +2329,7 @@ components: required: - members - duration + title: Response type: object QueryCallStatsRequest: nullable: true @@ -2223,6 +2358,7 @@ components: x-stream-index: "002" type: object QueryCallStatsResponse: + description: Basic response information nullable: true properties: duration: @@ -2244,12 +2380,14 @@ components: required: - reports - duration + title: Response type: object QueryCallsRequest: nullable: true properties: filter_conditions: additionalProperties: {} + title: Filters type: object x-stream-index: "003" limit: @@ -2265,11 +2403,14 @@ components: 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 @@ -2294,8 +2435,10 @@ components: required: - calls - duration + title: QueryCallsResponse type: object RTMPBroadcastRequest: + description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. properties: layout: $ref: '#/components/schemas/LayoutSettingsRequest' @@ -2338,16 +2481,18 @@ components: 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: RTMP Ingress + title: RTMPIngress type: object RTMPSettingsRequest: properties: @@ -2375,10 +2520,13 @@ components: 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: @@ -2386,26 +2534,20 @@ components: title: Layout x-stream-index: "003" quality: + title: Quality type: string x-stream-index: "002" required: - enabled - quality - layout - type: object - ReadReceipts: - properties: - enabled: - type: boolean - x-stream-index: "001" + title: RTMPSettingsResponse type: object ReadReceiptsResponse: properties: enabled: type: boolean x-stream-index: "001" - required: - - enabled type: object RecordSettingsRequest: properties: @@ -2421,6 +2563,7 @@ components: - available - disabled - auto-on + title: Mode type: string x-stream-index: "002" quality: @@ -2439,10 +2582,13 @@ components: 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: @@ -2450,9 +2596,11 @@ components: 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: @@ -2460,8 +2608,10 @@ components: - mode - quality - layout + title: RecordSettingsResponse type: object Response: + description: Basic response information nullable: true properties: duration: @@ -2471,6 +2621,7 @@ components: x-stream-index: "001" required: - duration + title: Response type: object RingSettingsRequest: properties: @@ -2577,6 +2728,7 @@ components: - access_request_enabled type: object SendCallEventRequest: + description: Send a call event to the other user nullable: true properties: custom: @@ -2590,15 +2742,19 @@ components: 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 SortParamRequest: nullable: true @@ -2616,25 +2772,44 @@ components: type: string x-stream-index: "001" type: object + StartClosedCaptionsRequest: + nullable: true + type: object + StartClosedCaptionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + 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: - description: Duration of the request in milliseconds - title: 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: @@ -2648,8 +2823,11 @@ components: 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: @@ -2659,6 +2837,7 @@ components: x-stream-index: "001.001" required: - duration + title: StartRTMPBroadcastsResponse type: object StartRecordingRequest: nullable: true @@ -2666,15 +2845,21 @@ components: 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 @@ -2682,18 +2867,23 @@ components: transcription_external_storage: type: string x-stream-index: "002" + title: StartTranscriptionRequest 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 @@ -2705,11 +2895,29 @@ components: x-stream-index: "001.001" required: - duration + title: StopAllRTMPBroadcastsResponse + type: object + StopClosedCaptionsRequest: + nullable: true + 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 StopHLSBroadcastingRequest: nullable: true type: object StopHLSBroadcastingResponse: + description: Basic response information nullable: true properties: duration: @@ -2719,29 +2927,35 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopLiveRequest: nullable: true + 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: - description: Duration of the request in milliseconds - title: 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: @@ -2751,11 +2965,13 @@ components: 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: @@ -2765,11 +2981,13 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object StopTranscriptionRequest: nullable: true type: object StopTranscriptionResponse: + description: Basic response information nullable: true properties: duration: @@ -2779,6 +2997,7 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object Subsession: nullable: true @@ -2873,6 +3092,10 @@ components: TranscriptionSettingsRequest: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -2894,6 +3117,10 @@ components: TranscriptionSettingsResponse: properties: closed_caption_mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "002" languages: @@ -2914,21 +3141,14 @@ components: - closed_caption_mode - languages type: object - TypingIndicators: - properties: - enabled: - type: boolean - x-stream-index: "001" - 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: @@ -2938,8 +3158,10 @@ components: 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: @@ -2949,8 +3171,10 @@ components: x-stream-index: "001.001" required: - duration + title: UnblockUserResponse type: object UnpinRequest: + description: UnpinRequest is the payload for unpinning a message. nullable: true properties: session_id: @@ -2966,8 +3190,10 @@ components: required: - user_id - session_id + title: UnpinRequest type: object UnpinResponse: + description: UnpinResponse is the payload for unpinning a message. nullable: true properties: duration: @@ -2977,8 +3203,10 @@ components: x-stream-index: "001.001" required: - duration + title: UnpinResponse type: object UpdateCallMembersRequest: + description: Update call members nullable: true properties: remove_members: @@ -2997,8 +3225,10 @@ components: title: Update Members type: array x-stream-index: "004" + title: UpdateCallMembersRequest type: object UpdateCallMembersResponse: + description: Basic response information nullable: true properties: duration: @@ -3014,8 +3244,10 @@ components: required: - duration - members + title: Response type: object UpdateCallRequest: + description: Request for updating a call nullable: true properties: custom: @@ -3035,9 +3267,10 @@ components: title: Starts At type: string x-stream-index: "005" + title: UpdateCallRequest type: object UpdateCallResponse: - description: Represents a call + description: Response for updating a call nullable: true properties: call: @@ -3062,9 +3295,10 @@ components: - own_capabilities - blocked_users - duration - title: Call + title: UpdateCallResponse type: object UpdateCallTypeRequest: + description: UpdateCallTypeRequest is the payload for updating a call type. nullable: true properties: external_storage: @@ -3083,18 +3317,24 @@ components: 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: @@ -3102,19 +3342,29 @@ components: 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: @@ -3125,6 +3375,7 @@ components: - created_at - updated_at - duration + title: UpdateCallTypeResponse type: object UpdateExternalStorageRequest: nullable: true @@ -3156,6 +3407,7 @@ components: - bucket type: object UpdateExternalStorageResponse: + description: Basic response information nullable: true properties: bucket: @@ -3185,6 +3437,7 @@ components: - bucket - path - duration + title: Response type: object UpdateUserPermissionsRequest: nullable: true @@ -3206,6 +3459,7 @@ components: - user_id type: object UpdateUserPermissionsResponse: + description: Basic response information nullable: true properties: duration: @@ -3215,31 +3469,37 @@ components: x-stream-index: "001.001" required: - duration + title: Response type: object UserInfoResponse: properties: custom: additionalProperties: {} type: object - x-stream-index: "003" + x-stream-index: "004" + id: + type: string + x-stream-index: "001" image: type: string - x-stream-index: "002" + x-stream-index: "003" name: type: string - x-stream-index: "001" + x-stream-index: "002" roles: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" required: + - id - name - image - custom - roles type: object UserRequest: + description: User request object properties: custom: additionalProperties: {} @@ -3267,7 +3527,7 @@ components: type: string x-stream-index: "002" privacy_settings: - $ref: '#/components/schemas/PrivacySettings' + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" push_notifications: $ref: '#/components/schemas/PushNotificationSettingsInput' @@ -3284,8 +3544,10 @@ components: x-stream-index: "009" required: - id + title: UserRequest type: object UserResponse: + description: User response object properties: ban_expires: description: Date when ban expires @@ -3330,7 +3592,7 @@ components: devices: description: List of devices user is using items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/DeviceResponse' title: Devices type: array x-stream-index: "006" @@ -3420,6 +3682,7 @@ components: - shadow_banned - devices - invisible + title: UserResponse type: object UserSessionStats: properties: @@ -3639,16 +3902,7 @@ components: - session_stats - min_event_ts type: object - VideoQuality: - properties: - resolution: - $ref: '#/components/schemas/VideoResolution' - x-stream-index: "002" - usage_type: - type: string - x-stream-index: "001" - type: object - VideoResolution: + VideoDimension: properties: height: type: integer @@ -3660,6 +3914,15 @@ components: - width - height type: object + VideoQuality: + properties: + resolution: + $ref: '#/components/schemas/VideoDimension' + x-stream-index: "002" + usage_type: + type: string + x-stream-index: "001" + type: object VideoSettingsRequest: properties: access_request_enabled: @@ -3751,7 +4014,7 @@ components: type: apiKey info: title: Stream API - version: v133.1.0 + version: v137.0.0 openapi: 3.0.3 paths: /video/call/{type}/{id}: @@ -3816,7 +4079,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallResponse' - description: Successful response + description: GetCallResponse "400": content: application/json: @@ -3868,6 +4131,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallRequest' + description: UpdateCallRequest required: true responses: "200": @@ -3875,7 +4139,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallResponse' - description: Call + description: UpdateCallResponse "400": content: application/json: @@ -3931,6 +4195,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallRequest' + description: GetOrCreateCallRequest required: true responses: "201": @@ -3938,7 +4203,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetOrCreateCallResponse' - description: Successful response + description: GetOrCreateCallResponse "400": content: application/json: @@ -4005,7 +4270,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteRecordingResponse' - description: Successful response + description: DeleteRecordingResponse "400": content: application/json: @@ -4072,7 +4337,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteTranscriptionResponse' - description: Successful response + description: DeleteTranscriptionResponse "400": content: application/json: @@ -4125,6 +4390,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserRequest' + description: BlockUserRequest required: true responses: "201": @@ -4132,7 +4398,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlockUserResponse' - description: Successful response + description: BlockUserResponse "400": content: application/json: @@ -4185,6 +4451,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallRequest' + description: DeleteCallRequest required: true responses: "201": @@ -4192,7 +4459,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCallResponse' - description: Successful response + description: DeleteCallResponse "400": content: application/json: @@ -4243,6 +4510,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventRequest' + description: SendCallEventRequest required: true responses: "201": @@ -4250,7 +4518,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SendCallEventResponse' - description: Successful response + description: SendCallEventResponse "400": content: application/json: @@ -4311,7 +4579,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CollectUserFeedbackResponse' - description: Successful response + description: Response "400": content: application/json: @@ -4364,6 +4632,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveRequest' + description: GoLiveRequest required: true responses: "201": @@ -4371,7 +4640,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GoLiveResponse' - description: Successful response + description: Response "400": content: application/json: @@ -4425,7 +4694,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EndCallResponse' - description: Successful response + description: EndCallResponse "400": content: application/json: @@ -4482,6 +4751,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersRequest' + description: UpdateCallMembersRequest required: true responses: "201": @@ -4489,7 +4759,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -4539,6 +4809,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersRequest' + description: MuteUsersRequest required: true responses: "201": @@ -4546,7 +4817,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MuteUsersResponse' - description: Successful response + description: MuteUsersResponse "400": content: application/json: @@ -4592,6 +4863,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinRequest' + description: PinRequest required: true responses: "201": @@ -4599,7 +4871,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PinResponse' - description: Successful response + description: Response "400": content: application/json: @@ -4646,7 +4918,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListRecordingsResponse' - description: Successful response + description: ListRecordingsResponse "400": content: application/json: @@ -4696,6 +4968,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsRequest' + description: StartRTMPBroadcastsRequest required: true responses: "201": @@ -4703,7 +4976,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRTMPBroadcastsResponse' - description: Successful response + description: StartRTMPBroadcastsResponse "400": content: application/json: @@ -4760,6 +5033,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsRequest' + description: StopRTMPBroadcastsRequest required: true responses: "201": @@ -4767,7 +5041,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRTMPBroadcastsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -4818,7 +5092,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopAllRTMPBroadcastsResponse' - description: Successful response + description: StopAllRTMPBroadcastsResponse "400": content: application/json: @@ -4869,7 +5143,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartHLSBroadcastingResponse' - description: Successful response + description: StartHLSBroadcastingResponse "400": content: application/json: @@ -4885,6 +5159,57 @@ paths: summary: Start HLS broadcasting tags: - product:video + /video/call/{type}/{id}/start_closed_captions: + post: + description: | + Starts closed captions + + Required permissions: + - StartClosedCaptions + 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" + 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_recording: post: description: | @@ -4922,6 +5247,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingRequest' + description: StartRecordingRequest required: true responses: "201": @@ -4929,7 +5255,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartRecordingResponse' - description: Successful response + description: StartRecordingResponse "400": content: application/json: @@ -4979,6 +5305,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionRequest' + description: StartTranscriptionRequest required: true responses: "201": @@ -4986,7 +5313,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StartTranscriptionResponse' - description: Successful response + description: StartTranscriptionResponse "400": content: application/json: @@ -5041,7 +5368,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5088,7 +5415,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopHLSBroadcastingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5104,6 +5431,56 @@ paths: summary: Stop HLS broadcasting tags: - product:video + /video/call/{type}/{id}/stop_closed_captions: + post: + description: | + Stops closed captions + + Sends events: + - call.transcription_stopped + + Required permissions: + - StopClosedCaptions + 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" + 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_live: post: description: |2 @@ -5142,7 +5519,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopLiveResponse' - description: Successful response + description: StopLiveResponse "400": content: application/json: @@ -5192,7 +5569,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopRecordingResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5242,7 +5619,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StopTranscriptionResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5271,7 +5648,9 @@ paths: name: type required: true schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true x-stream-index: "001.001" @@ -5279,7 +5658,9 @@ paths: name: id required: true schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true x-stream-index: "001.002" @@ -5289,7 +5670,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListTranscriptionsResponse' - description: Successful response + description: ListTranscriptionsResponse "400": content: application/json: @@ -5340,6 +5721,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserRequest' + description: UnblockUserRequest required: true responses: "201": @@ -5347,7 +5729,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnblockUserResponse' - description: Successful response + description: UnblockUserResponse "400": content: application/json: @@ -5393,6 +5775,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinRequest' + description: UnpinRequest required: true responses: "201": @@ -5400,7 +5783,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UnpinResponse' - description: Successful response + description: UnpinResponse "400": content: application/json: @@ -5456,7 +5839,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateUserPermissionsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5492,7 +5875,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallMembersResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5528,7 +5911,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallStatsResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5557,6 +5940,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsRequest' + description: QueryCallsRequest required: true responses: "201": @@ -5564,7 +5948,7 @@ paths: application/json: schema: $ref: '#/components/schemas/QueryCallsResponse' - description: Successful response + description: QueryCallsResponse "400": content: application/json: @@ -5591,7 +5975,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListCallTypeResponse' - description: Successful response + description: ListCallTypeResponse "400": content: application/json: @@ -5616,6 +6000,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCallTypeRequest' + description: CreateCallTypeRequest required: true responses: "201": @@ -5623,7 +6008,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCallTypeResponse' - description: Successful response + description: CreateCallTypeResponse "400": content: application/json: @@ -5658,7 +6043,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -5692,7 +6077,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetCallTypeResponse' - description: Successful response + description: GetCallTypeResponse "400": content: application/json: @@ -5725,6 +6110,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallTypeRequest' + description: UpdateCallTypeRequest required: true responses: "201": @@ -5732,7 +6118,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateCallTypeResponse' - description: Successful response + description: UpdateCallTypeResponse "400": content: application/json: @@ -5777,7 +6163,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -5812,7 +6198,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListDevicesResponse' - description: Successful response + description: ListDevicesResponse "400": content: application/json: @@ -5837,6 +6223,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": @@ -5844,7 +6231,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Response' - description: Successful response + description: Response "400": content: application/json: @@ -5871,7 +6258,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetEdgesResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5898,7 +6285,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5930,7 +6317,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -5965,7 +6352,7 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -6005,7 +6392,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: @@ -6040,7 +6427,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CheckExternalStorageResponse' - description: Successful response + description: Response "400": content: application/json: