chat-openapi-clientside.yaml

components:
  schemas:
    AIIndicatorClearEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: ai_indicator.clear
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: AIIndicatorClearEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AIIndicatorStopEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: ai_indicator.stop
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: AIIndicatorStopEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AIIndicatorUpdateEvent:
      properties:
        ai_message:
          type: string
          x-stream-index: "005"
        ai_state:
          type: string
          x-stream-index: "004"
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        message_id:
          type: string
          x-stream-index: "003"
        type:
          default: ai_indicator.update
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - message_id
      - ai_state
      title: AIIndicatorUpdateEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    APIError:
      nullable: true
      properties:
        StatusCode:
          description: Response HTTP status code
          format: int32
          title: Status code
          type: integer
          x-stream-index: "004"
        code:
          description: API error code
          format: int32
          title: Code
          type: integer
          x-stream-index: "001"
        details:
          description: Additional error-specific information
          items:
            type: integer
          title: Details
          type: array
          x-stream-index: "007"
        duration:
          description: Request duration
          title: Duration
          type: string
          x-stream-index: "005"
        exception_fields:
          additionalProperties:
            type: string
          description: Additional error info
          title: Exception fields
          type: object
          x-stream-index: "003"
        message:
          description: Message describing an error
          title: Message
          type: string
          x-stream-index: "002"
        more_info:
          description: URL with additional information
          title: More info
          type: string
          x-stream-index: "006"
        unrecoverable:
          description: Flag that indicates if the error is unrecoverable, requests
            that return unrecoverable errors should not be retried, this error only
            applies to the request that caused it
          title: Unrecoverable
          type: boolean
          x-stream-index: "008"
      required:
      - code
      - message
      - StatusCode
      - duration
      - more_info
      - details
      title: Error response
      type: object
    Action:
      nullable: true
      properties:
        name:
          type: string
          x-stream-index: "001"
        style:
          type: string
          x-stream-index: "003"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "004"
        value:
          type: string
          x-stream-index: "005"
      required:
      - name
      - text
      - type
      type: object
    ActivityMarkedEvent:
      properties:
        all_read:
          type: boolean
          x-stream-index: "006"
        all_seen:
          type: boolean
          x-stream-index: "007"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        feed_id:
          type: string
          x-stream-index: "003"
        marked_read:
          items:
            type: string
          type: array
          x-stream-index: "004"
        marked_watched:
          items:
            type: string
          type: array
          x-stream-index: "005"
        type:
          default: activity.marked
          type: string
          x-stream-index: "001.001"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - type
      - created_at
      - user_id
      - feed_id
      - all_read
      - all_seen
      title: ActivityMarkedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AnyEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: '*'
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      title: AnyEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AppEventResponse:
      properties:
        async_url_enrich_enabled:
          description: boolean
          title: Async URL Enrichment Enabled
          type: boolean
          x-stream-index: "002"
        auto_translation_enabled:
          description: boolean
          title: Auto Translation Enabled
          type: boolean
          x-stream-index: "003"
        file_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          description: file upload config
          title: File Upload Config
          x-stream-index: "004"
        image_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          description: file upload config
          title: Image Upload Config
          x-stream-index: "005"
        name:
          description: string
          title: App name
          type: string
          x-stream-index: "001"
      required:
      - name
      - auto_translation_enabled
      type: object
    AppResponseFields:
      properties:
        async_url_enrich_enabled:
          type: boolean
          x-stream-index: "020"
        auto_translation_enabled:
          type: boolean
          x-stream-index: "023"
        file_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          x-stream-index: "033"
        id:
          format: int32
          type: integer
          x-stream-index: "001"
        image_upload_config:
          $ref: '#/components/schemas/FileUploadConfig'
          x-stream-index: "034"
        name:
          type: string
          x-stream-index: "002"
        placement:
          type: string
          x-stream-index: "004"
      required:
      - id
      - name
      - organization
      - placement
      - 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
      - allow_multi_user_devices
      - image_moderation_enabled
      - async_url_enrich_enabled
      - auto_translation_enabled
      - custom_action_handler_url
      - enforce_unique_usernames
      - sqs_url
      - sqs_key
      - sqs_secret
      - sns_topic_arn
      - sns_key
      - sns_secret
      - file_upload_config
      - image_upload_config
      - grants
      - campaign_enabled
      - webhook_events
      - reminders_interval
      - cdn_expiration_seconds
      - video_provider
      - moderation_enabled
      - moderation_multitenant_blocklist_enabled
      - guest_user_creation_disabled
      - event_hooks
      - use_hook_v2
      - user_response_time_enabled
      - moderation_bulk_submit_action_enabled
      - moderation_llm_configurability_enabled
      - max_aggregated_activities_length
      type: object
    AppUpdatedEvent:
      description: Emitted when app settings are updated
      nullable: true
      properties:
        app:
          $ref: '#/components/schemas/AppEventResponse'
          description: application configuration
          title: App settings
          x-stream-index: "002"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        type:
          default: app.updated
          description: 'The type of event: "app.updated" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      - app
      title: AppUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    Attachment:
      description: An attachment is a message object that represents a file uploaded
        by a user.
      nullable: true
      properties:
        actions:
          items:
            $ref: '#/components/schemas/Action'
          type: array
          x-stream-index: "015"
        asset_url:
          type: string
          x-stream-index: "017"
        author_icon:
          type: string
          x-stream-index: "007"
        author_link:
          type: string
          x-stream-index: "006"
        author_name:
          type: string
          x-stream-index: "005"
        color:
          type: string
          x-stream-index: "003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "018"
        fallback:
          type: string
          x-stream-index: "002"
        fields:
          items:
            $ref: '#/components/schemas/Field'
          type: array
          x-stream-index: "016"
        footer:
          type: string
          x-stream-index: "013"
        footer_icon:
          type: string
          x-stream-index: "014"
        giphy:
          $ref: '#/components/schemas/Images'
          x-stream-index: "019"
        image_url:
          type: string
          x-stream-index: "011"
        og_scrape_url:
          type: string
          x-stream-index: "020"
        original_height:
          format: int32
          type: integer
          x-stream-index: "022"
        original_width:
          format: int32
          type: integer
          x-stream-index: "021"
        pretext:
          type: string
          x-stream-index: "004"
        text:
          type: string
          x-stream-index: "010"
        thumb_url:
          type: string
          x-stream-index: "012"
        title:
          type: string
          x-stream-index: "008"
        title_link:
          type: string
          x-stream-index: "009"
        type:
          description: Attachment type (e.g. image, video, url)
          title: Type
          type: string
          x-stream-index: "001"
      required:
      - custom
      title: Attachment
      type: object
      x-stream-docs-page-id: file_uploads
    AutomodDetails:
      properties:
        action:
          type: string
          x-stream-index: "001"
        image_labels:
          items:
            type: string
          type: array
          x-stream-index: "005"
        message_details:
          $ref: '#/components/schemas/FlagMessageDetails'
          x-stream-index: "004"
        original_message_type:
          type: string
          x-stream-index: "002"
        result:
          $ref: '#/components/schemas/MessageModerationResult'
          x-stream-index: "003"
      type: object
    BanRequest:
      nullable: true
      properties:
        banned_by:
          $ref: '#/components/schemas/UserRequest'
          description: User who issued a ban
          title: Banned by
          x-stream-index: "010"
        banned_by_id:
          description: User ID who issued a ban
          title: Banned by ID
          type: string
          x-stream-index: "009"
        channel_cid:
          description: Channel CID to ban user in eg. messaging:123
          title: Channel CID
          type: string
          x-stream-index: "006"
        delete_messages:
          enum:
          - soft
          - pruning
          - hard
          type: string
          x-stream-index: "011"
        ip_ban:
          description: Whether to perform IP ban or not
          title: IP ban
          type: boolean
          x-stream-index: "008"
        reason:
          description: Ban reason
          title: Reason
          type: string
          x-stream-index: "003"
        shadow:
          description: Whether to perform shadow ban or not
          title: Shadow
          type: boolean
          x-stream-index: "007"
        target_user_id:
          description: ID of user to ban
          title: Target user ID
          type: string
          x-stream-index: "001"
        timeout:
          description: Timeout of ban in minutes. User will be unbanned after this
            period of time
          title: Timeout
          type: integer
          x-stream-index: "002"
      required:
      - target_user_id
      type: object
    BanResponse:
      nullable: true
      properties:
        banned_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "006"
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "007"
        expires:
          format: date-time
          type: string
          x-stream-index: "003"
        reason:
          type: string
          x-stream-index: "004"
        shadow:
          type: boolean
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
      required:
      - created_at
      type: object
    BlockListOptions:
      properties:
        behavior:
          description: Blocklist behavior
          enum:
          - flag
          - block
          - shadow_block
          title: Behavior
          type: string
          x-stream-index: "002"
        blocklist:
          description: Blocklist name
          title: Blocklist
          type: string
          x-stream-index: "001"
      required:
      - blocklist
      - behavior
      type: object
    BlockListResponse:
      description: Block list contains restricted words
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "001"
        id:
          type: string
          x-stream-index: "003"
        is_leet_check_enabled:
          type: boolean
          x-stream-index: "008"
        is_plural_check_enabled:
          type: boolean
          x-stream-index: "009"
        name:
          description: Block list name
          title: Name
          type: string
          x-stream-index: "004"
        team:
          type: string
          x-stream-index: "007"
        type:
          description: Block list type.
          title: Type
          type: string
          x-stream-index: "005"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "002"
        words:
          description: List of words to block
          items:
            type: string
          title: Words
          type: array
          x-stream-index: "006"
      required:
      - name
      - type
      - words
      - is_leet_check_enabled
      - is_plural_check_enabled
      title: Block list
      type: object
      x-stream-docs-page-id: block_lists
    BlockUsersRequest:
      nullable: true
      properties:
        blocked_user_id:
          description: User id to block
          title: BlockedUserID
          type: string
          x-stream-index: "001"
      required:
      - blocked_user_id
      type: object
    BlockUsersResponse:
      nullable: true
      properties:
        blocked_by_user_id:
          description: User id who blocked another user
          title: BlockedByUserID
          type: string
          x-stream-index: "002"
        blocked_user_id:
          description: User id who got blocked
          title: BlockedUserID
          type: string
          x-stream-index: "003"
        created_at:
          description: Timestamp when the user was blocked
          format: date-time
          title: CreatedAt
          type: string
          x-stream-index: "004"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      - blocked_by_user_id
      - blocked_user_id
      - created_at
      type: object
    BlockedUserResponse:
      nullable: true
      properties:
        blocked_user:
          $ref: '#/components/schemas/UserResponse'
          description: User who got blocked
          title: User
          x-stream-index: "003"
        blocked_user_id:
          description: ID of the user who got blocked
          title: UserID
          type: string
          x-stream-index: "004"
        created_at:
          format: date-time
          type: string
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who blocked another user
          title: User
          x-stream-index: "001"
        user_id:
          description: ID of the user who blocked another user
          title: UserID
          type: string
          x-stream-index: "002"
      required:
      - user
      - user_id
      - blocked_user
      - blocked_user_id
      - created_at
      type: object
    CastPollVoteRequest:
      nullable: true
      properties:
        vote:
          $ref: '#/components/schemas/VoteData'
          description: Vote data
          title: VoteData
          x-stream-index: "004"
      type: object
    Channel:
      properties:
        active_live_locations:
          items:
            $ref: '#/components/schemas/SharedLocation'
          type: array
          x-stream-index: "035"
        auto_translation_enabled:
          type: boolean
          x-stream-index: "030"
        auto_translation_language:
          type: string
          x-stream-index: "031"
        cid:
          type: string
          x-stream-index: "003"
        config:
          $ref: '#/components/schemas/ChannelConfig'
          x-stream-index: "027"
        config_overrides:
          $ref: '#/components/schemas/ConfigOverrides'
          x-stream-index: "028"
        cooldown:
          format: int32
          type: integer
          x-stream-index: "032"
        created_at:
          format: date-time
          type: string
          x-stream-index: "009"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "019"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "011"
        disabled:
          type: boolean
          x-stream-index: "017"
        filter_tags:
          items:
            type: string
          type: array
          x-stream-index: "038"
        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: "023"
        last_campaigns:
          type: string
          x-stream-index: "033"
        last_message_at:
          format: date-time
          type: string
          x-stream-index: "006"
        member_count:
          format: int32
          type: integer
          x-stream-index: "021"
        members:
          items:
            $ref: '#/components/schemas/ChannelMember'
          type: array
          x-stream-index: "020"
        members_lookup:
          additionalProperties:
            $ref: '#/components/schemas/ChannelMemberLookup'
          type: object
          x-stream-index: "022"
        message_count:
          format: int64
          type: integer
          x-stream-index: "036"
        message_count_updated_at:
          format: date-time
          type: string
          x-stream-index: "037"
        team:
          type: string
          x-stream-index: "029"
        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:
            description: List of grants modifiers that apply to a role
            key: role
            title: Grants
        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.028
        automod:
          enum:
          - disabled
          - simple
          - AI
          type: string
          x-stream-index: 001.002.023
        automod_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.024
        automod_thresholds:
          $ref: '#/components/schemas/Thresholds'
          x-stream-index: 001.002.029
        blocklist:
          type: string
          x-stream-index: 001.002.025
        blocklist_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.026
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListOptions'
          type: array
          x-stream-index: 001.002.027
        commands:
          items:
            $ref: '#/components/schemas/Command'
          type: array
          x-stream-index: "001.003"
        connect_events:
          type: boolean
          x-stream-index: 001.002.004
        count_messages:
          type: boolean
          x-stream-index: 001.002.020
        created_at:
          format: date-time
          type: string
          x-stream-index: 001.001.003
        custom_events:
          type: boolean
          x-stream-index: 001.002.013
        delivery_events:
          type: boolean
          x-stream-index: 001.002.005
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "002"
        mark_messages_pending:
          type: boolean
          x-stream-index: 001.002.016
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: 001.002.022
        mutes:
          type: boolean
          x-stream-index: 001.002.010
        name:
          type: string
          x-stream-index: 001.002.001
        partition_size:
          format: int32
          type: integer
          x-stream-index: 001.002.030
        partition_ttl:
          example: 24h
          format: duration
          nullable: true
          type: string
          x-stream-index: 001.002.031
        polls:
          type: boolean
          x-stream-index: 001.002.017
        push_notifications:
          type: boolean
          x-stream-index: 001.002.014
        quotes:
          type: boolean
          x-stream-index: 001.002.009
        reactions:
          type: boolean
          x-stream-index: 001.002.007
        read_events:
          type: boolean
          x-stream-index: 001.002.003
        reminders:
          type: boolean
          x-stream-index: 001.002.015
        replies:
          type: boolean
          x-stream-index: 001.002.008
        search:
          type: boolean
          x-stream-index: 001.002.006
        shared_locations:
          type: boolean
          x-stream-index: 001.002.019
        skip_last_msg_update_for_system_msgs:
          type: boolean
          x-stream-index: 001.002.032
        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.011
        url_enrichment:
          type: boolean
          x-stream-index: 001.002.012
        user_message_reminders:
          type: boolean
          x-stream-index: 001.002.018
      required:
      - created_at
      - updated_at
      - name
      - typing_events
      - read_events
      - connect_events
      - delivery_events
      - search
      - reactions
      - replies
      - quotes
      - mutes
      - uploads
      - url_enrichment
      - custom_events
      - push_notifications
      - reminders
      - mark_messages_pending
      - polls
      - user_message_reminders
      - shared_locations
      - count_messages
      - message_retention
      - max_message_length
      - automod
      - automod_behavior
      - skip_last_msg_update_for_system_msgs
      - commands
      type: object
    ChannelCreatedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: channel.created
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      title: ChannelCreatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelDeletedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003.004"
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "003.005"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        team:
          type: string
          x-stream-index: "001.001"
        type:
          default: channel.deleted
          type: string
          x-stream-index: "002.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: ChannelDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelFrozenEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: channel.frozen
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: ChannelFrozenEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelGetOrCreateRequest:
      nullable: true
      properties:
        data:
          $ref: '#/components/schemas/ChannelInput'
          x-stream-index: "003"
        hide_for_creator:
          description: Whether this channel will be hidden for the user who created
            the channel or not
          title: Hide for creator
          type: boolean
          x-stream-index: "007"
        members:
          $ref: '#/components/schemas/PaginationParams'
          x-stream-index: "010"
        messages:
          $ref: '#/components/schemas/MessagePaginationParams'
          x-stream-index: "009"
        presence:
          description: Fetch user presence info
          title: Presence
          type: boolean
          x-stream-index: "006"
        state:
          description: Refresh channel state
          title: State
          type: boolean
          x-stream-index: "005"
        thread_unread_counts:
          type: boolean
          x-stream-index: "008"
        watch:
          description: Start watching the channel
          title: Watch
          type: boolean
          x-stream-index: "004"
        watchers:
          $ref: '#/components/schemas/PaginationParams'
          x-stream-index: "011"
      type: object
    ChannelHiddenEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003.004"
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "003.005"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        clear_history:
          type: boolean
          x-stream-index: "001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        type:
          default: channel.hidden
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002.001"
      required:
      - clear_history
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      - type
      - created_at
      title: ChannelHiddenEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelInput:
      properties:
        auto_translation_enabled:
          description: Enable or disable auto translation
          title: Auto translation
          type: boolean
          x-stream-index: "005"
        auto_translation_language:
          description: Switch auto translation language
          title: Auto translation language
          type: string
          x-stream-index: "006"
        config_overrides:
          $ref: '#/components/schemas/ChannelConfig'
          x-stream-index: "024"
        created_by:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "009"
        created_by_id:
          type: string
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "015"
        disabled:
          type: boolean
          x-stream-index: "014"
        filter_tags:
          items:
            type: string
          type: array
          x-stream-index: "026"
        frozen:
          description: Freeze or unfreeze the channel
          title: Frozen
          type: boolean
          x-stream-index: "013"
        invites:
          items:
            $ref: '#/components/schemas/ChannelMemberRequest'
          maximum: 100
          type: array
          x-stream-index: "016"
        members:
          items:
            $ref: '#/components/schemas/ChannelMemberRequest'
          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
    ChannelInputRequest:
      properties:
        auto_translation_enabled:
          type: boolean
          x-stream-index: "002"
        auto_translation_language:
          type: string
          x-stream-index: "003"
        config_overrides:
          $ref: '#/components/schemas/ConfigOverrides'
          x-stream-index: "009"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "010"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        disabled:
          type: boolean
          x-stream-index: "005"
        frozen:
          type: boolean
          x-stream-index: "004"
        invites:
          items:
            $ref: '#/components/schemas/ChannelMember'
          maximum: 100
          type: array
          x-stream-index: "007"
        members:
          items:
            $ref: '#/components/schemas/ChannelMember'
          maximum: 100
          type: array
          x-stream-index: "008"
        team:
          type: string
          x-stream-index: "001"
      type: object
    ChannelKickedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002.004"
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "002.005"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: channel.kicked
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: ChannelKickedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelMember:
      nullable: true
      properties:
        archived_at:
          format: date-time
          type: string
          x-stream-index: "021"
        ban_expires:
          format: date-time
          type: string
          x-stream-index: "017"
        banned:
          type: boolean
          x-stream-index: "016"
        blocked:
          type: boolean
          x-stream-index: "031"
        channel:
          $ref: '#/components/schemas/DenormalizedChannelFields'
          x-stream-index: "029"
        channel_role:
          type: string
          x-stream-index: "026"
        created_at:
          format: date-time
          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"
        deleted_messages:
          items:
            type: string
          type: array
          x-stream-index: "032"
        hidden:
          type: boolean
          x-stream-index: "030"
        invite_accepted_at:
          format: date-time
          type: string
          x-stream-index: "009"
        invite_rejected_at:
          format: date-time
          type: string
          x-stream-index: "010"
        invited:
          type: boolean
          x-stream-index: "008"
        is_global_banned:
          type: boolean
          x-stream-index: "020"
        is_moderator:
          type: boolean
          x-stream-index: "007"
        notifications_muted:
          type: boolean
          x-stream-index: "028"
        pinned_at:
          format: date-time
          type: string
          x-stream-index: "022"
        shadow_banned:
          type: boolean
          x-stream-index: "019"
        status:
          type: string
          x-stream-index: "011"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "013"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005"
        user_id:
          type: string
          x-stream-index: "004"
      type: object
    ChannelMemberLookup:
      nullable: true
      properties:
        archived:
          type: boolean
          x-stream-index: "003"
        archived_at:
          format: date-time
          type: string
          x-stream-index: "007"
        ban_expires:
          format: date-time
          type: string
          x-stream-index: "008"
        banned:
          type: boolean
          x-stream-index: "004"
        blocked:
          type: boolean
          x-stream-index: "005"
        hidden:
          type: boolean
          x-stream-index: "001"
        pinned:
          type: boolean
          x-stream-index: "002"
        pinned_at:
          format: date-time
          type: string
          x-stream-index: "006"
      required:
      - hidden
      - pinned
      - archived
      - banned
      - blocked
      type: object
    ChannelMemberRequest:
      nullable: true
      properties:
        channel_role:
          description: Role of the member in the channel
          title: Channel Role
          type: string
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
        user_id:
          title: User ID
          type: string
          x-stream-index: "001"
      required:
      - user_id
      title: Channel member
      type: object
    ChannelMemberResponse:
      properties:
        channel_role:
          type: string
          x-stream-index: "001"
      required:
      - channel_role
      type: object
    ChannelMute:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Channel that is muted
          title: Channel
          x-stream-index: "002"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "004"
        expires:
          description: Date/time of mute expiration
          format: date-time
          title: Expires
          type: string
          x-stream-index: "003"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Owner of channel mute
          title: User
          x-stream-index: "001"
      required:
      - created_at
      - updated_at
      type: object
    ChannelOwnCapability:
      description: All possibility of string to use
      enum:
      - ban-channel-members
      - cast-poll-vote
      - connect-events
      - create-attachment
      - delete-any-message
      - delete-channel
      - delete-own-message
      - delivery-events
      - flag-message
      - freeze-channel
      - join-channel
      - leave-channel
      - mute-channel
      - pin-message
      - query-poll-votes
      - quote-message
      - read-events
      - search-messages
      - send-custom-events
      - send-links
      - send-message
      - send-poll
      - send-reaction
      - send-reply
      - send-restricted-visibility-message
      - send-typing-events
      - set-channel-cooldown
      - share-location
      - skip-slow-mode
      - slow-mode
      - typing-events
      - update-any-message
      - update-channel
      - update-channel-members
      - update-own-message
      - update-thread
      - upload-file
      title: ChannelOwnCapability
      type: string
    ChannelPushPreferences:
      nullable: true
      properties:
        chat_level:
          type: string
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: string
          x-stream-index: "002"
      type: object
    ChannelPushPreferencesResponse:
      properties:
        chat_level:
          type: string
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: string
          x-stream-index: "002"
      type: object
    ChannelResponse:
      description: Represents channel in chat
      properties:
        auto_translation_enabled:
          description: Whether auto translation is enabled or not
          title: Auto translation
          type: boolean
          x-stream-index: "017"
        auto_translation_language:
          description: Language to translate to when auto translation is active
          title: Auto translation language
          type: string
          x-stream-index: "018"
        blocked:
          description: Whether this channel is blocked by current user or not
          title: Blocked
          type: boolean
          x-stream-index: "023"
        cid:
          description: Channel CID (<type>:<id>)
          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"
        filter_tags:
          description: List of filter tags associated with the channel
          items:
            type: string
          title: Filter tags
          type: array
          x-stream-index: "028"
        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/ChannelMemberResponse'
          title: Channel members
          type: array
          x-stream-index: "011"
        message_count:
          description: Number of messages in the channel
          format: int64
          title: Message count
          type: integer
          x-stream-index: "027"
        mute_expires_at:
          description: Date of mute expiration
          format: date-time
          title: Mute expires at
          type: string
          x-stream-index: "015"
        muted:
          description: Whether this channel is muted or not
          title: Muted
          type: boolean
          x-stream-index: "014"
        own_capabilities:
          description: List of channel capabilities of authenticated user
          items:
            $ref: '#/components/schemas/ChannelOwnCapability'
          title: ChannelOwnCapability
          type: array
          x-stream-index: "021"
        team:
          description: Team the channel belongs to (multi-tenant only)
          title: Team
          type: string
          x-stream-index: "016"
        truncated_at:
          description: Date of the latest truncation of the channel
          format: date-time
          title: UserResponse
          type: string
          x-stream-index: "024"
        truncated_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "025"
        type:
          description: Type of the channel
          title: Type
          type: string
          x-stream-docs-page-id: channel_features
          x-stream-index: "002"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "006"
      required:
      - id
      - type
      - cid
      - created_at
      - updated_at
      - frozen
      - disabled
      - custom
      title: Channel
      type: object
    ChannelStateResponse:
      nullable: true
      properties:
        active_live_locations:
          items:
            $ref: '#/components/schemas/SharedLocationResponseData'
          type: array
          x-stream-index: "001.015"
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "001.001"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "001.014"
        duration:
          type: string
          x-stream-index: "002.001"
        hidden:
          type: boolean
          x-stream-index: "001.011"
        hide_messages_before:
          format: date-time
          type: string
          x-stream-index: "001.012"
        members:
          items:
            $ref: '#/components/schemas/ChannelMemberResponse'
          type: array
          x-stream-index: "001.007"
        membership:
          $ref: '#/components/schemas/ChannelMemberResponse'
          x-stream-index: "001.008"
        messages:
          items:
            $ref: '#/components/schemas/MessageResponse'
          type: array
          x-stream-index: "001.002"
        pending_messages:
          items:
            $ref: '#/components/schemas/PendingMessageResponse'
          type: array
          x-stream-index: "001.013"
        pinned_messages:
          items:
            $ref: '#/components/schemas/MessageResponse'
          type: array
          x-stream-index: "001.003"
        push_preferences:
          $ref: '#/components/schemas/ChannelPushPreferencesResponse'
          x-stream-index: "001.009"
        read:
          items:
            $ref: '#/components/schemas/ReadStateResponse'
          type: array
          x-stream-index: "001.006"
        threads:
          items:
            $ref: '#/components/schemas/ThreadStateResponse'
          type: array
          x-stream-index: "001.010"
        watcher_count:
          format: int32
          type: integer
          x-stream-index: "001.004"
        watchers:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "001.005"
      required:
      - messages
      - pinned_messages
      - members
      - threads
      - duration
      type: object
    ChannelStateResponseFields:
      properties:
        active_live_locations:
          description: Active live locations in the channel
          items:
            $ref: '#/components/schemas/SharedLocationResponseData'
          title: Active Live Locations
          type: array
          x-stream-index: "015"
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "001"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "014"
        hidden:
          description: Whether this channel is hidden or not
          title: Hidden
          type: boolean
          x-stream-index: "011"
        hide_messages_before:
          description: Messages before this date are hidden from the user
          format: date-time
          title: Hide messages before
          type: string
          x-stream-index: "012"
        members:
          description: List of channel members
          items:
            $ref: '#/components/schemas/ChannelMemberResponse'
          title: Members
          type: array
          x-stream-index: "007"
        membership:
          $ref: '#/components/schemas/ChannelMemberResponse'
          description: Current user membership object
          title: Membership
          x-stream-index: "008"
        messages:
          description: List of channel messages
          items:
            $ref: '#/components/schemas/MessageResponse'
          title: Message
          type: array
          x-stream-index: "002"
        pending_messages:
          description: Pending messages that this user has sent
          items:
            $ref: '#/components/schemas/PendingMessageResponse'
          title: Pending messages
          type: array
          x-stream-index: "013"
        pinned_messages:
          description: List of pinned messages in the channel
          items:
            $ref: '#/components/schemas/MessageResponse'
          title: Pinned messages
          type: array
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "003"
        push_preferences:
          $ref: '#/components/schemas/ChannelPushPreferencesResponse'
          x-stream-index: "009"
        read:
          description: List of read states
          items:
            $ref: '#/components/schemas/ReadStateResponse'
          title: Read
          type: array
          x-stream-index: "006"
        threads:
          items:
            $ref: '#/components/schemas/ThreadStateResponse'
          type: array
          x-stream-index: "010"
        watcher_count:
          description: Number of channel watchers
          format: int32
          title: Watcher count
          type: integer
          x-stream-index: "004"
        watchers:
          description: List of user who is watching the channel
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Watchers
          type: array
          x-stream-index: "005"
      required:
      - messages
      - pinned_messages
      - members
      - threads
      type: object
    ChannelStopWatchingRequest:
      nullable: true
      type: object
    ChannelTruncatedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "001.004"
        channel_id:
          type: string
          x-stream-index: "001.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "001.005"
        channel_type:
          type: string
          x-stream-index: "001.003"
        cid:
          type: string
          x-stream-index: "001.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        type:
          default: channel.truncated
          type: string
          x-stream-index: "002.001"
      required:
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      - type
      - created_at
      title: ChannelTruncatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelUnFrozenEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: channel.unfrozen
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: ChannelUnFrozenEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelUpdatedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "004.004"
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "004.005"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001"
        team:
          type: string
          x-stream-index: "002.001"
        type:
          default: channel.updated
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: ChannelUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ChannelVisibleEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "001.002"
        channel_type:
          type: string
          x-stream-index: "001.003"
        cid:
          type: string
          x-stream-index: "001.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.002"
        type:
          default: channel.visible
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002.001"
      required:
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: ChannelVisibleEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    Command:
      description: Represents custom chat command
      nullable: true
      properties:
        args:
          description: Arguments help text, shown in commands auto-completion
          title: Arguments
          type: string
          x-stream-index: "006"
        created_at:
          description: Date/time of creation
          format: date-time
          readOnly: true
          title: Created at
          type: string
          x-stream-index: "001"
        description:
          description: Description, shown in commands auto-completion
          title: Description
          type: string
          x-stream-index: "005"
        name:
          description: Unique command name
          title: Name
          type: string
          x-stream-index: "004"
        set:
          description: Set name used for grouping commands
          title: Set
          type: string
          x-stream-index: "007"
        updated_at:
          description: Date/time of the last update
          format: date-time
          readOnly: true
          title: Updated at
          type: string
          x-stream-index: "002"
      required:
      - name
      - description
      - args
      - set
      title: Command
      type: object
    ConfigOverrides:
      properties:
        blocklist:
          type: string
          x-stream-index: "008"
        blocklist_behavior:
          enum:
          - flag
          - block
          type: string
          x-stream-index: "009"
        commands:
          items:
            type: string
          type: array
          x-stream-index: "011"
        count_messages:
          type: boolean
          x-stream-index: "014"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "010"
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: "007"
        quotes:
          type: boolean
          x-stream-index: "004"
        reactions:
          type: boolean
          x-stream-index: "002"
        replies:
          type: boolean
          x-stream-index: "003"
        shared_locations:
          type: boolean
          x-stream-index: "013"
        typing_events:
          type: boolean
          x-stream-index: "001"
        uploads:
          type: boolean
          x-stream-index: "005"
        url_enrichment:
          type: boolean
          x-stream-index: "006"
        user_message_reminders:
          type: boolean
          x-stream-index: "012"
      type: object
    ConnectRequest:
      properties:
        device:
          $ref: '#/components/schemas/DeviceFields'
          x-stream-index: "001.002"
        user_details:
          $ref: '#/components/schemas/User'
          x-stream-index: "001.001"
      required:
      - user_details
      type: object
    CreateBlockListRequest:
      description: Block list contains restricted words
      nullable: true
      properties:
        is_leet_check_enabled:
          type: boolean
          x-stream-index: "001"
        is_plural_check_enabled:
          type: boolean
          x-stream-index: "002"
        name:
          description: Block list name
          maxLength: 255
          title: Name
          type: string
          x-stream-index: "003"
        team:
          type: string
          x-stream-index: "006"
        type:
          description: Block list type.
          enum:
          - regex
          - domain
          - domain_allowlist
          - email
          - email_allowlist
          - word
          title: Type
          type: string
          x-stream-index: "005"
        words:
          description: List of words to block
          items:
            type: string
          minimum: 1
          title: Words
          type: array
          x-stream-index: "004"
      required:
      - name
      - words
      title: Block list
      type: object
      x-stream-docs-page-id: block_lists
    CreateBlockListResponse:
      description: Basic response information
      nullable: true
      properties:
        blocklist:
          $ref: '#/components/schemas/BlockListResponse'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      title: Response
      type: object
    CreateDeviceRequest:
      description: Create device request
      nullable: true
      properties:
        id:
          description: Device ID
          maxLength: 255
          minLength: 1
          title: ID
          type: string
          x-stream-index: "001"
        push_provider:
          description: Push provider
          enum:
          - firebase
          - apn
          - huawei
          - xiaomi
          title: PushProvider
          type: string
          x-stream-index: "002"
        push_provider_name:
          description: Push provider name
          title: PushProviderName
          type: string
          x-stream-index: "003"
        voip_token:
          description: When true the token is for Apple VoIP push notifications
          title: VoipToken
          type: boolean
          x-stream-index: "004"
      required:
      - id
      - push_provider
      title: CreateDeviceRequest
      type: object
    CreateDraftRequest:
      nullable: true
      properties:
        message:
          $ref: '#/components/schemas/MessageRequest'
          x-stream-index: "001"
      required:
      - message
      type: object
    CreateDraftResponse:
      description: Basic response information
      nullable: true
      properties:
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - draft
      - duration
      title: Response
      type: object
    CreateGuestRequest:
      nullable: true
      properties:
        user:
          $ref: '#/components/schemas/UserRequest'
          description: User object which server acts upon
          title: User
          x-stream-index: "001"
      required:
      - user
      type: object
    CreateGuestResponse:
      nullable: true
      properties:
        access_token:
          description: the access token to authenticate the user
          title: Access token
          type: string
          x-stream-index: "002"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User object which server acts upon
          title: User
          x-stream-index: "001"
      required:
      - user
      - access_token
      - duration
      type: object
    CreatePollOptionRequest:
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "003"
        text:
          description: Option text
          title: string
          type: string
          x-stream-index: "002"
      required:
      - text
      type: object
    CreatePollRequest:
      description: Contains all information needed to create a new poll
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "011"
        allow_answers:
          description: Indicates whether users can suggest user defined answers
          title: Allow answers
          type: boolean
          x-stream-index: "009"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "008"
        description:
          description: A description of the poll
          title: Description
          type: string
          x-stream-index: "003"
        enforce_unique_vote:
          description: Indicates whether users can cast multiple votes
          title: Multiple choice
          type: boolean
          x-stream-index: "006"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        is_closed:
          description: Indicates whether the poll is open for voting
          title: Is closed
          type: boolean
          x-stream-index: "010"
        max_votes_allowed:
          description: Indicates the maximum amount of votes a user can cast
          format: int32
          maximum: 10
          title: Maximum votes allowed
          type: integer
          x-stream-index: "007"
        name:
          description: The name of the poll
          title: Name
          type: string
          x-stream-index: "002"
        options:
          items:
            $ref: '#/components/schemas/PollOptionInput'
          maximum: 100
          type: array
          x-stream-index: "004"
        voting_visibility:
          enum:
          - anonymous
          - public
          type: string
          x-stream-index: "005"
      required:
      - name
      title: Create Poll Request
      type: object
    CreateReminderRequest:
      nullable: true
      properties:
        remind_at:
          format: date-time
          type: string
          x-stream-index: "001"
      type: object
    DeleteChannelResponse:
      description: Basic response information
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    DeleteChannelsRequest:
      nullable: true
      properties:
        cids:
          description: All channels that should be deleted
          items:
            type: string
          maximum: 100
          minimum: 1
          title: Channels CID
          type: array
          x-stream-index: "001"
        hard_delete:
          description: Specify if channels and all ressources should be hard deleted
          title: Hard delete
          type: boolean
          x-stream-index: "002"
      required:
      - cids
      type: object
    DeleteChannelsResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        result:
          additionalProperties:
            $ref: '#/components/schemas/DeleteChannelsResultResponse'
          description: Map of channel IDs and their deletion results
          title: Result
          type: object
          x-stream-index: "001"
        task_id:
          type: string
          x-stream-index: "002"
      required:
      - duration
      type: object
    DeleteChannelsResultResponse:
      nullable: true
      properties:
        error:
          type: string
          x-stream-index: "002"
        status:
          type: string
          x-stream-index: "001"
      required:
      - status
      type: object
    DeleteMessageResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "001"
      required:
      - message
      - duration
      title: Response
      type: object
    DeleteReactionResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "001"
        reaction:
          $ref: '#/components/schemas/ReactionResponse'
          x-stream-index: "002"
      required:
      - message
      - reaction
      - duration
      title: Response
      type: object
    DeleteReminderResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    DeliveredMessagePayload:
      properties:
        cid:
          type: string
          x-stream-index: "001"
        id:
          type: string
          x-stream-index: "002"
      type: object
    DeliveryReceipts:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    DeliveryReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    DenormalizedChannelFields:
      properties:
        created_at:
          type: string
          x-stream-index: "001"
        created_by_id:
          type: string
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "011"
        disabled:
          type: boolean
          x-stream-index: "005"
        frozen:
          type: boolean
          x-stream-index: "006"
        id:
          type: string
          x-stream-index: "010"
        last_message_at:
          type: string
          x-stream-index: "003"
        member_count:
          format: int32
          type: integer
          x-stream-index: "004"
        team:
          type: string
          x-stream-index: "007"
        type:
          type: string
          x-stream-index: "009"
        updated_at:
          type: string
          x-stream-index: "002"
      type: object
    Device:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        disabled:
          type: boolean
          x-stream-index: "002.003"
        disabled_reason:
          type: string
          x-stream-index: "002.004"
        id:
          type: string
          x-stream-index: 002.001.004
        push_provider:
          enum:
          - firebase
          - apn
          - huawei
          - xiaomi
          type: string
          x-stream-index: 002.001.001
        push_provider_name:
          type: string
          x-stream-index: 002.001.003
        user_id:
          type: string
          x-stream-index: "004"
        voip:
          type: boolean
          x-stream-index: 002.001.005
      required:
      - push_provider
      - id
      - created_at
      - user_id
      type: object
    DeviceFields:
      properties:
        id:
          type: string
          x-stream-index: "004"
        push_provider:
          enum:
          - firebase
          - apn
          - huawei
          - xiaomi
          type: string
          x-stream-index: "001"
        push_provider_name:
          type: string
          x-stream-index: "003"
        voip:
          type: boolean
          x-stream-index: "005"
      required:
      - push_provider
      - id
      type: object
    DeviceResponse:
      description: Response for Device
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "004"
        disabled:
          description: Whether device is disabled or not
          title: Disabled
          type: boolean
          x-stream-index: "005"
        disabled_reason:
          description: Reason explaining why device had been disabled
          title: Reason
          type: string
          x-stream-index: "006"
        id:
          description: Device ID
          title: ID
          type: string
          x-stream-index: "003"
        push_provider:
          description: Push provider
          title: PushProvider
          type: string
          x-stream-index: "001"
        push_provider_name:
          description: Push provider name
          title: PushProviderName
          type: string
          x-stream-index: "002"
        user_id:
          description: User ID
          title: UserID
          type: string
          x-stream-index: "008"
        voip:
          description: When true the token is for Apple VoIP push notifications
          title: Voip
          type: boolean
          x-stream-index: "007"
      required:
      - push_provider
      - id
      - created_at
      - user_id
      title: DeviceResponse
      type: object
    DraftDeletedEvent:
      description: Emitted when a Draft is deleted.
      nullable: true
      properties:
        cid:
          description: The CID of the channel where the draft was created
          title: Channel CID
          type: string
          x-stream-index: 001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.007
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "001.003"
        parent_id:
          description: The ID of the parent message
          title: Message ID
          type: string
          x-stream-index: "001.002"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.004
        type:
          default: draft.deleted
          description: 'The type of event: "draft.deleted" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.002
      required:
      - type
      - created_at
      - custom
      title: DraftDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    DraftPayloadResponse:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "007"
        html:
          type: string
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "001"
        mentioned_users:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "008"
        mml:
          type: string
          x-stream-index: "003"
        parent_id:
          type: string
          x-stream-index: "005"
        poll_id:
          type: string
          x-stream-index: "013"
        quoted_message_id:
          type: string
          x-stream-index: "009"
        show_in_channel:
          type: boolean
          x-stream-index: "006"
        silent:
          type: boolean
          x-stream-index: "012"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "011"
      required:
      - id
      - text
      - custom
      type: object
    DraftResponse:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003"
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "007"
        message:
          $ref: '#/components/schemas/DraftPayloadResponse'
          x-stream-index: "001"
        parent_id:
          type: string
          x-stream-index: "004"
        parent_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "005"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "006"
      required:
      - message
      - channel_cid
      - created_at
      type: object
    DraftUpdatedEvent:
      description: Emitted when a Draft is created or updated.
      nullable: true
      properties:
        cid:
          description: The CID of the channel where the draft was created/updated
          title: Channel CID
          type: string
          x-stream-index: 001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.007
        draft:
          $ref: '#/components/schemas/DraftResponse'
          description: The draft object which was created/updated
          title: Draft
          x-stream-index: "001.003"
        parent_id:
          description: The ID of the parent message
          title: Parent ID
          type: string
          x-stream-index: "001.002"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.004
        type:
          default: draft.updated
          description: 'The type of event: "draft.updated" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.002
      required:
      - type
      - created_at
      - custom
      title: DraftUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    EventRequest:
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        parent_id:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "001"
      required:
      - type
      type: object
    EventResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        event:
          $ref: '#/components/schemas/WSEvent'
          x-stream-index: "001"
      required:
      - event
      - duration
      title: Response
      type: object
    FeedsPreferences:
      properties:
        comment:
          type: string
          x-stream-index: "002"
        comment_reaction:
          type: string
          x-stream-index: "004"
        comment_reply:
          type: string
          x-stream-index: "005"
        custom_activity_types:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "007"
        follow:
          type: string
          x-stream-index: "001"
        mention:
          type: string
          x-stream-index: "006"
        reaction:
          type: string
          x-stream-index: "003"
      type: object
    FeedsPreferencesResponse:
      properties:
        comment:
          type: string
          x-stream-index: "002"
        comment_reaction:
          type: string
          x-stream-index: "004"
        custom_activity_types:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "006"
        follow:
          type: string
          x-stream-index: "001"
        mention:
          type: string
          x-stream-index: "005"
        reaction:
          type: string
          x-stream-index: "003"
      type: object
    Field:
      nullable: true
      properties:
        short:
          type: boolean
          x-stream-index: "003"
        title:
          type: string
          x-stream-index: "001"
        value:
          type: string
          x-stream-index: "002"
      required:
      - title
      - value
      - short
      type: object
    FileUploadConfig:
      properties:
        allowed_file_extensions:
          items:
            type: string
          type: array
          x-stream-index: "001"
        allowed_mime_types:
          items:
            type: string
          type: array
          x-stream-index: "003"
        blocked_file_extensions:
          items:
            type: string
          type: array
          x-stream-index: "002"
        blocked_mime_types:
          items:
            type: string
          type: array
          x-stream-index: "004"
        size_limit:
          format: int32
          maximum: 104857600
          minimum: 0
          type: integer
          x-stream-index: "005"
      required:
      - allowed_file_extensions
      - blocked_file_extensions
      - allowed_mime_types
      - blocked_mime_types
      - size_limit
      type: object
    FileUploadRequest:
      nullable: true
      properties:
        file:
          description: file field
          title: File
          type: string
          x-stream-index: "001"
        user:
          $ref: '#/components/schemas/OnlyUserID'
          description: user for the request **server side only**
          title: User
          x-stream-index: "002"
      type: object
    FileUploadResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        file:
          description: URL to the uploaded asset. Should be used to put to `asset_url`
            attachment field
          title: File
          type: string
          x-stream-index: "001"
        thumb_url:
          description: URL of the file thumbnail for supported file formats. Should
            be put to `thumb_url` attachment field
          title: Thumbnail URL
          type: string
          x-stream-index: "002"
      required:
      - duration
      type: object
    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
    FlagMessageResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "003.001"
        flag:
          $ref: '#/components/schemas/FlagResponse'
          description: Flag object
          title: Flag
          x-stream-index: "001"
        review_queue_item_id:
          description: ID of review queue item if moderation v2 is enabled
          title: Review Queue Item ID
          type: string
          x-stream-index: "002"
      required:
      - review_queue_item_id
      - duration
      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:
      properties:
        approved_at:
          format: date-time
          type: string
          x-stream-index: "010"
        created_at:
          format: date-time
          type: string
          x-stream-index: "006"
        created_by_automod:
          type: boolean
          x-stream-index: "001"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "014"
        details:
          $ref: '#/components/schemas/FlagDetails'
          x-stream-index: "013"
        reason:
          type: string
          x-stream-index: "012"
        rejected_at:
          format: date-time
          type: string
          x-stream-index: "011"
        reviewed_at:
          format: date-time
          type: string
          x-stream-index: "008"
        reviewed_by:
          type: string
          x-stream-index: "009"
        target_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "004"
        target_message_id:
          type: string
          x-stream-index: "003"
        target_user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "005"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
      required:
      - created_by_automod
      - created_at
      - updated_at
      type: object
    FullUserResponse:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        ban_expires:
          format: date-time
          type: string
          x-stream-index: "015"
        banned:
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "014"
        channel_mutes:
          items:
            $ref: '#/components/schemas/ChannelMute'
          type: array
          x-stream-index: "007"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          format: date-time
          type: string
          x-stream-index: "001.016"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "001.011"
        devices:
          items:
            $ref: '#/components/schemas/DeviceResponse'
          type: array
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: "001.001"
        image:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "005"
        language:
          type: string
          x-stream-index: "001.005"
        last_active:
          format: date-time
          type: string
          x-stream-index: "001.014"
        latest_hidden_channels:
          items:
            type: string
          type: array
          x-stream-index: "012"
        mutes:
          items:
            $ref: '#/components/schemas/UserMuteResponse'
          type: array
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "001.002"
        online:
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "003"
        revoke_tokens_issued_before:
          format: date-time
          type: string
          x-stream-index: "001.015"
        role:
          type: string
          x-stream-index: "001.006"
        shadow_banned:
          type: boolean
          x-stream-index: "013"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "009"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "010"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "008"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "011"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - devices
      - invisible
      - mutes
      - channel_mutes
      - unread_count
      - total_unread_count
      - unread_channels
      - unread_threads
      - shadow_banned
      - blocked_user_ids
      type: object
    GetApplicationResponse:
      description: Basic response information
      nullable: true
      properties:
        app:
          $ref: '#/components/schemas/AppResponseFields'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - app
      - duration
      title: Response
      type: object
    GetBlockedUsersResponse:
      nullable: true
      properties:
        blocks:
          description: Array of blocked user object
          items:
            $ref: '#/components/schemas/BlockedUserResponse'
          title: Blocks
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - blocks
      - duration
      type: object
    GetDraftResponse:
      description: Basic response information
      nullable: true
      properties:
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - draft
      - duration
      title: Response
      type: object
    GetManyMessagesResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: 001.002.001
        messages:
          description: List of messages
          items:
            $ref: '#/components/schemas/MessageResponse'
          title: Messages
          type: array
          x-stream-index: "001.001"
      required:
      - messages
      - duration
      type: object
    GetMessageResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        message:
          $ref: '#/components/schemas/MessageWithChannelResponse'
          x-stream-index: "001"
        pending_message_metadata:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "002"
      required:
      - message
      - duration
      title: Response
      type: object
    GetOGResponse:
      nullable: true
      properties:
        actions:
          items:
            $ref: '#/components/schemas/Action'
          type: array
          x-stream-index: "001.015"
        asset_url:
          description: URL of detected video or audio
          title: Image URL
          type: string
          x-stream-index: "001.017"
        author_icon:
          type: string
          x-stream-index: "001.007"
        author_link:
          description: og:site
          title: Author Link
          type: string
          x-stream-index: "001.006"
        author_name:
          description: og:site_name
          title: Author Name
          type: string
          x-stream-index: "001.005"
        color:
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.018"
        duration:
          type: string
          x-stream-index: "002.001"
        fallback:
          type: string
          x-stream-index: "001.002"
        fields:
          items:
            $ref: '#/components/schemas/Field'
          type: array
          x-stream-index: "001.016"
        footer:
          type: string
          x-stream-index: "001.013"
        footer_icon:
          type: string
          x-stream-index: "001.014"
        giphy:
          $ref: '#/components/schemas/Images'
          x-stream-index: "001.019"
        image_url:
          description: URL of detected image
          title: Image URL
          type: string
          x-stream-index: "001.011"
        og_scrape_url:
          description: extracted url from the text
          title: OG Scrape URL
          type: string
          x-stream-index: "001.020"
        original_height:
          format: int32
          type: integer
          x-stream-index: "001.022"
        original_width:
          format: int32
          type: integer
          x-stream-index: "001.021"
        pretext:
          type: string
          x-stream-index: "001.004"
        text:
          description: og:description
          title: Text
          type: string
          x-stream-index: "001.010"
        thumb_url:
          description: URL of detected thumb image
          title: Image URL
          type: string
          x-stream-index: "001.012"
        title:
          description: og:title
          title: Title
          type: string
          x-stream-index: "001.008"
        title_link:
          description: og:url
          title: Title Link
          type: string
          x-stream-index: "001.009"
        type:
          description: Attachment type, could be empty, image, audio or video
          title: Type
          type: string
          x-stream-index: "001.001"
      required:
      - custom
      - duration
      title: Get OG Attachment
      type: object
      x-stream-docs-page-id: og
    GetReactionsResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        reactions:
          description: List of reactions
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Reactions
          type: array
          x-stream-index: "001"
      required:
      - reactions
      - duration
      type: object
    GetRepliesResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        messages:
          items:
            $ref: '#/components/schemas/MessageResponse'
          type: array
          x-stream-index: "001"
      required:
      - messages
      - duration
      title: Response
      type: object
    GetThreadResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        thread:
          $ref: '#/components/schemas/ThreadStateResponse'
          description: Enriched thread state
          title: Thread
          x-stream-index: "001"
      required:
      - thread
      - duration
      type: object
    HealthCheckEvent:
      nullable: true
      properties:
        cid:
          type: string
          x-stream-index: "003"
        connection_id:
          type: string
          x-stream-index: "001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004.007"
        me:
          $ref: '#/components/schemas/OwnUserResponse'
          x-stream-index: "002"
        received_at:
          format: date-time
          type: string
          x-stream-index: "004.004"
        type:
          default: health.check
          type: string
          x-stream-index: "004.002"
      required:
      - connection_id
      - type
      - created_at
      - custom
      title: HealthCheckEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    HideChannelRequest:
      nullable: true
      properties:
        clear_history:
          description: Whether to clear message history of the channel or not
          title: Clear history
          type: boolean
          x-stream-index: "001"
      type: object
    HideChannelResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    ImageData:
      properties:
        frames:
          type: string
          x-stream-index: "005"
        height:
          type: string
          x-stream-index: "003"
        size:
          type: string
          x-stream-index: "004"
        url:
          type: string
          x-stream-index: "001"
        width:
          type: string
          x-stream-index: "002"
      required:
      - url
      - width
      - height
      - size
      - frames
      type: object
    ImageSize:
      properties:
        crop:
          description: Crop mode
          enum:
          - top
          - bottom
          - left
          - right
          - center
          title: Crop
          type: string
          x-stream-index: "001"
        height:
          description: Target image height
          format: int32
          title: Height
          type: integer
          x-stream-index: "003"
        resize:
          description: Resize method
          enum:
          - clip
          - crop
          - scale
          - fill
          title: Resize
          type: string
          x-stream-index: "002"
        width:
          description: Target image width
          format: int32
          title: Width
          type: integer
          x-stream-index: "004"
      title: Image size configuration
      type: object
    ImageUploadRequest:
      nullable: true
      properties:
        file:
          type: string
          x-stream-index: "001.001"
        upload_sizes:
          description: field with JSON-encoded array of image size configurations
          items:
            $ref: '#/components/schemas/ImageSize'
          title: Upload sizes
          type: array
          x-stream-index: "002"
        user:
          $ref: '#/components/schemas/OnlyUserID'
          x-stream-index: "001.002"
      type: object
    ImageUploadResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: 001.003.001
        file:
          type: string
          x-stream-index: "001.001"
        thumb_url:
          type: string
          x-stream-index: "001.002"
        upload_sizes:
          description: Array of image size configurations
          items:
            $ref: '#/components/schemas/ImageSize'
          title: Upload sizes
          type: array
          x-stream-index: "002"
      required:
      - duration
      type: object
    Images:
      properties:
        fixed_height:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "002"
        fixed_height_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "004"
        fixed_height_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "003"
        fixed_width:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "005"
        fixed_width_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "007"
        fixed_width_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "006"
        original:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "001"
      required:
      - original
      - fixed_height
      - fixed_height_still
      - fixed_height_downsampled
      - fixed_width
      - fixed_width_still
      - fixed_width_downsampled
      type: object
    Label:
      properties:
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "003"
        name:
          type: string
          x-stream-index: "001"
        phrase_list_ids:
          items:
            format: int32
            type: integer
          type: array
          x-stream-index: "002"
      required:
      - name
      type: object
    LabelThresholds:
      properties:
        block:
          description: Threshold for automatic message block
          format: float
          maximum: 1
          minimum: 0
          title: Block
          type: number
          x-stream-index: "002"
        flag:
          description: Threshold for automatic message flag
          format: float
          maximum: 1
          minimum: 0
          title: Flag
          type: number
          x-stream-index: "001"
      type: object
    ListBlockListResponse:
      description: Basic response information
      nullable: true
      properties:
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListResponse'
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - blocklists
      - duration
      title: Response
      type: object
    ListDevicesResponse:
      description: List devices response
      nullable: true
      properties:
        devices:
          description: List of devices
          items:
            $ref: '#/components/schemas/DeviceResponse'
          title: Devices
          type: array
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - devices
      - duration
      title: ListDevicesResponse
      type: object
    MarkChannelsReadRequest:
      nullable: true
      properties:
        read_by_channel:
          additionalProperties:
            type: string
          description: Map of channel ID to last read message ID
          maximum: 30
          title: Read by channel
          type: object
          x-stream-index: "001"
      type: object
    MarkDeliveredRequest:
      nullable: true
      properties:
        latest_delivered_messages:
          items:
            $ref: '#/components/schemas/DeliveredMessagePayload'
          type: array
          x-stream-index: "001"
      type: object
    MarkDeliveredResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    MarkReadRequest:
      nullable: true
      properties:
        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"
        message_timestamp:
          description: Timestamp of the message from where the channel is marked unread
          format: date-time
          title: Message Timestamp
          type: string
          x-stream-index: "004"
        thread_id:
          description: Mark a thread unread, specify one of the thread, message timestamp,
            or message id
          title: Thread ID
          type: string
          x-stream-index: "003"
      type: object
    MemberAddedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "001.001"
        team:
          type: string
          x-stream-index: "002.001"
        type:
          default: member.added
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: MemberAddedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MemberRemovedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "001.001"
        type:
          default: member.removed
          type: string
          x-stream-index: "002.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "004.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: MemberRemovedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MemberUpdatedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "005.002"
        channel_type:
          type: string
          x-stream-index: "005.003"
        cid:
          type: string
          x-stream-index: "005.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "001.001"
        team:
          type: string
          x-stream-index: "002.001"
        type:
          default: member.updated
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "004.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: MemberUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MembersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        members:
          description: List of found members
          items:
            $ref: '#/components/schemas/ChannelMemberResponse'
          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: "013"
        before_message_send_failed:
          type: boolean
          x-stream-index: "047"
        cid:
          type: string
          x-stream-index: "029"
        command:
          type: string
          x-stream-index: "007"
        created_at:
          format: date-time
          type: string
          x-stream-index: "031"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "035"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "034"
        deleted_for_me:
          type: boolean
          x-stream-index: "061"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "024"
        html:
          type: string
          x-stream-index: "008"
        i18n:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "045"
        id:
          type: string
          x-stream-index: "002"
        image_labels:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "041"
        latest_reactions:
          items:
            $ref: '#/components/schemas/Reaction'
          type: array
          x-stream-index: "014"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "060"
        mentioned_users:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "044"
        message_text_updated_at:
          format: date-time
          type: string
          x-stream-index: "053"
        mml:
          type: string
          x-stream-index: "006"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "057"
        own_reactions:
          items:
            $ref: '#/components/schemas/Reaction'
          type: array
          x-stream-index: "015"
        parent_id:
          type: string
          x-stream-index: "020"
        pin_expires:
          format: date-time
          type: string
          x-stream-index: "052"
        pinned:
          type: boolean
          x-stream-index: "048"
        pinned_at:
          format: date-time
          type: string
          x-stream-index: "049"
        pinned_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "051"
        poll:
          $ref: '#/components/schemas/Poll'
          x-stream-index: "055"
        poll_id:
          type: string
          x-stream-index: "054"
        quoted_message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "026"
        quoted_message_id:
          type: string
          x-stream-index: "025"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "016"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "018"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "017"
        reminder:
          $ref: '#/components/schemas/MessageReminder'
          x-stream-index: "059"
        reply_count:
          format: int32
          type: integer
          x-stream-index: "023"
        restricted_visibility:
          items:
            type: string
          type: array
          x-stream-index: "012"
        shadowed:
          type: boolean
          x-stream-index: "037"
        shared_location:
          $ref: '#/components/schemas/SharedLocation'
          x-stream-index: "056"
        show_in_channel:
          type: boolean
          x-stream-index: "022"
        silent:
          type: boolean
          x-stream-index: "046"
        text:
          type: string
          x-stream-index: "004"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "028"
        type:
          type: string
          x-stream-index: "009"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "032"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "011"
      required:
      - id
      - text
      - html
      - type
      - restricted_visibility
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reaction_groups
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - silent
      - pinned
      type: object
    MessageActionRequest:
      nullable: true
      properties:
        form_data:
          additionalProperties:
            type: string
          description: ReadOnlyData to execute command with
          title: Form data
          type: object
          x-stream-index: "002"
      required:
      - form_data
      type: object
    MessageChangeSet:
      properties:
        attachments:
          type: boolean
          x-stream-index: "005"
        custom:
          type: boolean
          x-stream-index: "001"
        html:
          type: boolean
          x-stream-index: "004"
        mentioned_user_ids:
          type: boolean
          x-stream-index: "006"
        mml:
          type: boolean
          x-stream-index: "003"
        pin:
          type: boolean
          x-stream-index: "009"
        quoted_message_id:
          type: boolean
          x-stream-index: "007"
        silent:
          type: boolean
          x-stream-index: "008"
        text:
          type: boolean
          x-stream-index: "002"
      required:
      - custom
      - text
      - mml
      - html
      - attachments
      - mentioned_user_ids
      - quoted_message_id
      - silent
      - pin
      type: object
    MessageDeletedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "007.002"
        deleted_for_me:
          type: boolean
          x-stream-index: "003"
        hard_delete:
          type: boolean
          x-stream-index: "002.001"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001.001"
        team:
          type: string
          x-stream-index: "006.001"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "001.002"
        type:
          default: message.deleted
          type: string
          x-stream-index: "007.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005.001"
      required:
      - hard_delete
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: MessageDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MessageDeliveredEvent:
      description: Emitted when a message is marked as delivered.
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003.001"
        channel_custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.006
        channel_id:
          description: The ID of the channel where the message was read
          title: Channel ID
          type: string
          x-stream-index: 001.002.002
        channel_member_count:
          description: The number of members in the channel
          format: int32
          title: Channel Member Count
          type: integer
          x-stream-index: 001.001.004
        channel_message_count:
          description: The number of messages in the channel
          format: int64
          title: Channel Message Count
          type: integer
          x-stream-index: 001.001.005
        channel_type:
          description: The type of the channel where the message was read
          title: Channel Type
          type: string
          x-stream-index: 001.002.001
        cid:
          description: The CID of the channel where the message was read
          title: Channel CID
          type: string
          x-stream-index: 001.001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.001.007
        last_delivered_at:
          description: The time when the message was delivered
          title: Last Delivered At
          type: string
          x-stream-index: "005"
        last_delivered_message_id:
          description: The ID of the last delivered message
          title: Last Delivered Message ID
          type: string
          x-stream-index: "004"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.001.004
        team:
          description: The team ID
          title: Team
          type: string
          x-stream-index: 001.001.003
        type:
          default: message.delivered
          description: 'The type of event: "message.delivered" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.001.002
        user:
          $ref: '#/components/schemas/UserResponseCommonFields'
          description: The user that received the message
          title: User
          x-stream-index: "002.001"
      required:
      - type
      - created_at
      - custom
      title: MessageDeliveredEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MessageFlagResponse:
      nullable: true
      properties:
        approved_at:
          format: date-time
          type: string
          x-stream-index: "013"
        created_at:
          format: date-time
          type: string
          x-stream-index: "009"
        created_by_automod:
          type: boolean
          x-stream-index: "001"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "008"
        details:
          $ref: '#/components/schemas/FlagDetails'
          x-stream-index: "006"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "005"
        moderation_feedback:
          $ref: '#/components/schemas/FlagFeedback'
          x-stream-index: "003"
        moderation_result:
          $ref: '#/components/schemas/MessageModerationResult'
          x-stream-index: "002"
        reason:
          type: string
          x-stream-index: "007"
        rejected_at:
          format: date-time
          type: string
          x-stream-index: "014"
        reviewed_at:
          format: date-time
          type: string
          x-stream-index: "011"
        reviewed_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "012"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "010"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "004"
      required:
      - created_by_automod
      - created_at
      - updated_at
      type: object
    MessageModerationResult:
      description: Result of the message moderation
      properties:
        action:
          description: Action taken by automod
          title: Action
          type: string
          x-stream-index: "002"
        ai_moderation_response:
          $ref: '#/components/schemas/ModerationResponse'
          description: Response from AI moderation
          title: ModerationResponse
          x-stream-index: "007"
        blocked_word:
          description: Word that was blocked
          title: Blocked word
          type: string
          x-stream-index: "004"
        blocklist_name:
          description: Name of the blocklist
          title: Blocklist name
          type: string
          x-stream-index: "005"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "010"
        message_id:
          description: ID of the message
          title: Message ID
          type: string
          x-stream-index: "001"
        moderated_by:
          description: User who moderated the message
          title: Moderated by
          type: string
          x-stream-index: "003"
        moderation_thresholds:
          $ref: '#/components/schemas/Thresholds'
          description: Thresholds for AI moderation
          title: Thresholds
          x-stream-index: "006"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "011"
        user_bad_karma:
          description: Whether user has bad karma
          title: User bad karma
          type: boolean
          x-stream-index: "009"
        user_karma:
          description: Karma of the user
          format: float
          title: User karma
          type: number
          x-stream-index: "008"
      required:
      - message_id
      - action
      - user_karma
      - user_bad_karma
      - created_at
      - updated_at
      title: Message moderation result
      type: object
    MessageNewEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "005.002"
        channel_type:
          type: string
          x-stream-index: "005.003"
        cid:
          type: string
          x-stream-index: "005.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001.001"
        team:
          type: string
          x-stream-index: "006.001"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "001.002"
        type:
          default: message.new
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
        watcher_count:
          format: int32
          type: integer
          x-stream-index: "002.001"
      required:
      - watcher_count
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: MessageNewEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MessageOptions:
      properties:
        include_thread_participants:
          type: boolean
          x-stream-index: "001"
      type: object
    MessagePaginationParams:
      properties:
        created_at_after:
          description: The timestamp to get messages with a created_at timestamp greater
            than
          format: date-time
          title: Created_at after
          type: string
          x-stream-index: "008"
        created_at_after_or_equal:
          description: The timestamp to get messages with a created_at timestamp greater
            than or equal to
          format: date-time
          title: Created_at after or equal
          type: string
          x-stream-index: "007"
        created_at_around:
          description: The result will be a set of messages, that are both older and
            newer than the created_at timestamp provided, distributed evenly around
            the timestamp
          format: date-time
          title: Created_at around
          type: string
          x-stream-index: "012"
        created_at_before:
          description: The timestamp to get messages with a created_at timestamp smaller
            than
          format: date-time
          title: Created_at after before
          type: string
          x-stream-index: "010"
        created_at_before_or_equal:
          description: The timestamp to get messages with a created_at timestamp smaller
            than or equal to
          format: date-time
          title: Created_at after before or equal
          type: string
          x-stream-index: "009"
        id_around:
          description: The result will be a set of messages, that are both older and
            newer than the message with the provided ID, and the message with the
            ID provided will be in the middle of the set
          title: Id around
          type: string
          x-stream-index: "011"
        id_gt:
          description: The ID of the message to get messages with a timestamp greater
            than
          title: IDGT
          type: string
          x-stream-index: "004"
        id_gte:
          description: The ID of the message to get messages with a timestamp greater
            than or equal to
          title: IDGTE
          type: string
          x-stream-index: "003"
        id_lt:
          description: The ID of the message to get messages with a timestamp smaller
            than
          title: IDLT
          type: string
          x-stream-index: "006"
        id_lte:
          description: The ID of the message to get messages with a timestamp smaller
            than or equal to
          title: IDLTE
          type: string
          x-stream-index: "005"
        limit:
          description: 'The maximum number of messages to return (max limit '
          format: int32
          minimum: 0
          title: Limit
          type: integer
          x-stream-index: "001"
      type: object
    MessageReadEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "011"
        channel_id:
          type: string
          x-stream-index: "003"
        channel_last_message_at:
          format: date-time
          type: string
          x-stream-index: "005"
        channel_type:
          type: string
          x-stream-index: "004"
        cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "009"
        last_read_message_id:
          type: string
          x-stream-index: "010"
        team:
          type: string
          x-stream-index: "006"
        thread:
          $ref: '#/components/schemas/ThreadResponse'
          x-stream-index: "008"
        type:
          default: message.read
          type: string
          x-stream-index: "001"
        user:
          $ref: '#/components/schemas/UserResponseCommonFields'
          x-stream-index: "007"
      required:
      - type
      - cid
      - channel_id
      - channel_type
      - created_at
      type: object
    MessageReminder:
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
          x-stream-index: "004"
        channel_cid:
          type: string
          x-stream-index: "003"
        created_at:
          format: date-time
          type: string
          x-stream-index: "011"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "006"
        message_id:
          type: string
          x-stream-index: "005"
        remind_at:
          format: date-time
          type: string
          x-stream-index: "009"
        task_id:
          type: string
          x-stream-index: "010"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "012"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "008"
        user_id:
          type: string
          x-stream-index: "007"
      required:
      - channel_cid
      - message_id
      - user_id
      - task_id
      - created_at
      - updated_at
      type: object
    MessageRequest:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          maximum: 30
          type: array
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "007"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        mentioned_users:
          items:
            type: string
          maximum: 100
          type: array
          x-stream-index: "008"
        mml:
          type: string
          x-stream-index: "003"
        parent_id:
          type: string
          x-stream-index: "005"
        pin_expires:
          format: date-time
          type: string
          x-stream-index: "015"
        pinned:
          type: boolean
          x-stream-index: "013"
        pinned_at:
          format: date-time
          nullable: true
          type: string
          x-stream-index: "014"
        poll_id:
          type: string
          x-stream-index: "039"
        quoted_message_id:
          type: string
          x-stream-index: "009"
        restricted_visibility:
          items:
            type: string
          maximum: 10
          type: array
          x-stream-index: "016"
        shared_location:
          $ref: '#/components/schemas/SharedLocation'
          x-stream-index: "040"
        show_in_channel:
          type: boolean
          x-stream-index: "006"
        silent:
          type: boolean
          x-stream-index: "012"
        text:
          type: string
          x-stream-index: "002"
        type:
          enum:
          - ''''''
          - regular
          - system
          type: string
          x-stream-index: "011"
      type: object
    MessageResponse:
      description: Represents any chat message
      properties:
        attachments:
          description: Array of message attachments
          items:
            $ref: '#/components/schemas/Attachment'
          title: Message attachments
          type: array
          x-stream-docs-page-id: message_format#attachment-format
          x-stream-index: "009"
        cid:
          description: Channel unique identifier in <type>:<id> format
          title: Channel CID
          type: string
          x-stream-index: "023"
        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: "024"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "027"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: string
          x-stream-index: "026"
        deleted_for_me:
          type: boolean
          x-stream-index: "045"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "019"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "042"
        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: "031"
        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: "029"
        latest_reactions:
          description: List of 10 latest reactions to this message
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Latest reactions
          type: array
          x-stream-index: "010"
        member:
          $ref: '#/components/schemas/ChannelMemberResponse'
          description: Channel member data for the message sender including only the
            `channel_role`
          title: Member object
          x-stream-index: "008"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "030"
        message_text_updated_at:
          format: date-time
          type: string
          x-stream-index: "037"
        mml:
          description: Should be empty if `text` is provided. Can only be set when
            using server-side API
          title: Messaging Markup Language
          type: string
          x-stream-docs-page-id: mml_overview
          x-stream-index: "003"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "040"
        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: "011"
        parent_id:
          description: ID of parent message (thread)
          title: Parent message ID
          type: string
          x-stream-docs-page-id: threads
          x-stream-index: "016"
        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: "036"
        pinned:
          description: Whether message is pinned or not
          title: Pinned
          type: boolean
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "033"
        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: "034"
        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: "035"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "039"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "038"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          description: Contains quoted message
          title: Quoted message
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "021"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "020"
        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: "012"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "015"
        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: "013"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "043"
        reply_count:
          description: Number of replies to this message
          format: int32
          title: Reply count
          type: integer
          x-stream-index: "018"
        restricted_visibility:
          description: A list of user ids that have restricted visibility to the message,
            if the list is not empty, the message is only visible to the users in
            the list
          items:
            type: string
          title: Restricted visibility
          type: array
          x-stream-index: "041"
        shadowed:
          description: Whether the message was shadowed or not
          title: Shadowed
          type: boolean
          x-stream-docs-page-id: moderation#shadow-ban
          x-stream-index: "028"
        shared_location:
          $ref: '#/components/schemas/SharedLocationResponseData'
          description: Contains shared location data
          title: Shared Location
          x-stream-index: "044"
        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: "017"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "032"
        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: "022"
        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: "025"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Sender of the message. Required when using server-side API
          title: User object
          x-stream-index: "007"
      required:
      - id
      - text
      - html
      - type
      - user
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - silent
      - pinned
      - restricted_visibility
      title: Message
      type: object
      x-stream-docs-page-id: send_message
    MessageUndeletedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "005.002"
        channel_type:
          type: string
          x-stream-index: "005.003"
        cid:
          type: string
          x-stream-index: "005.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001.001"
        team:
          type: string
          x-stream-index: "002.001"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "001.002"
        type:
          default: message.undeleted
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: MessageUndeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MessageUpdate:
      properties:
        change_set:
          $ref: '#/components/schemas/MessageChangeSet'
          x-stream-index: "002"
        old_text:
          type: string
          x-stream-index: "001"
      type: object
    MessageUpdatedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "005.002"
        channel_type:
          type: string
          x-stream-index: "005.003"
        cid:
          type: string
          x-stream-index: "005.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001.001"
        team:
          type: string
          x-stream-index: "002.001"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "001.002"
        type:
          default: message.updated
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: MessageUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    MessageWithChannelResponse:
      description: Represents any chat message
      properties:
        attachments:
          description: Array of message attachments
          items:
            $ref: '#/components/schemas/Attachment'
          title: Message attachments
          type: array
          x-stream-docs-page-id: message_format#attachment-format
          x-stream-index: "001.009"
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Channel object
          title: Channel
          x-stream-index: "002"
        cid:
          description: Channel unique identifier in <type>:<id> format
          title: Channel CID
          type: string
          x-stream-index: "001.023"
        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.024"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.027"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: string
          x-stream-index: "001.026"
        deleted_for_me:
          type: boolean
          x-stream-index: "001.045"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "001.019"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "001.042"
        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.031"
        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.029"
        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.010"
        member:
          $ref: '#/components/schemas/ChannelMemberResponse'
          description: Channel member data for the message sender including only the
            `channel_role`
          title: Member object
          x-stream-index: "001.008"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "001.030"
        message_text_updated_at:
          format: date-time
          type: string
          x-stream-index: "001.037"
        mml:
          description: Should be empty if `text` is provided. Can only be set when
            using server-side API
          title: Messaging Markup Language
          type: string
          x-stream-docs-page-id: mml_overview
          x-stream-index: "001.003"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "001.040"
        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.011"
        parent_id:
          description: ID of parent message (thread)
          title: Parent message ID
          type: string
          x-stream-docs-page-id: threads
          x-stream-index: "001.016"
        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.036"
        pinned:
          description: Whether message is pinned or not
          title: Pinned
          type: boolean
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "001.033"
        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.034"
        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.035"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "001.039"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "001.038"
        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.021"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "001.020"
        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.012"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "001.015"
        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.013"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "001.043"
        reply_count:
          description: Number of replies to this message
          format: int32
          title: Reply count
          type: integer
          x-stream-index: "001.018"
        restricted_visibility:
          description: A list of user ids that have restricted visibility to the message,
            if the list is not empty, the message is only visible to the users in
            the list
          items:
            type: string
          title: Restricted visibility
          type: array
          x-stream-index: "001.041"
        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.028"
        shared_location:
          $ref: '#/components/schemas/SharedLocationResponseData'
          description: Contains shared location data
          title: Shared Location
          x-stream-index: "001.044"
        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.017"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "001.032"
        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.022"
        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.025"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Sender of the message. Required when using server-side API
          title: User object
          x-stream-index: "001.007"
      required:
      - id
      - text
      - html
      - type
      - user
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - silent
      - pinned
      - restricted_visibility
      - channel
      title: Message
      type: object
      x-stream-docs-page-id: send_message
    ModerationResponse:
      properties:
        action:
          type: string
          x-stream-index: "004"
        explicit:
          format: float
          type: number
          x-stream-index: "002"
        spam:
          format: float
          type: number
          x-stream-index: "003"
        toxic:
          format: float
          type: number
          x-stream-index: "001"
      required:
      - toxic
      - explicit
      - spam
      - action
      - automod_response
      type: object
    ModerationV2Response:
      properties:
        action:
          type: string
          x-stream-index: "001"
        blocklist_matched:
          type: string
          x-stream-index: "005"
        image_harms:
          items:
            type: string
          type: array
          x-stream-index: "004"
        original_text:
          type: string
          x-stream-index: "002"
        platform_circumvented:
          type: boolean
          x-stream-index: "007"
        semantic_filter_matched:
          type: string
          x-stream-index: "006"
        text_harms:
          items:
            type: string
          type: array
          x-stream-index: "003"
      required:
      - action
      - original_text
      type: object
    MuteChannelRequest:
      nullable: true
      properties:
        channel_cids:
          description: Channel CIDs to mute (if multiple channels)
          items:
            type: string
          maximum: 25
          title: Channel CIDs
          type: array
          x-stream-index: "002"
        expiration:
          description: Duration of mute in milliseconds
          title: Expiration
          type: integer
          x-stream-index: "003"
      type: object
    MuteChannelResponse:
      nullable: true
      properties:
        channel_mute:
          $ref: '#/components/schemas/ChannelMute'
          description: Object with channel mute (if one channel was muted)
          title: Channel mute
          x-stream-index: "001"
        channel_mutes:
          description: Object with mutes (if multiple channels were muted)
          items:
            $ref: '#/components/schemas/ChannelMute'
          title: Channel mutes
          type: array
          x-stream-index: "002"
        duration:
          type: string
          x-stream-index: "004.001"
        own_user:
          $ref: '#/components/schemas/OwnUser'
          description: Authorized user object with fresh mutes information
          title: Own user
          x-stream-index: "003"
      required:
      - duration
      type: object
    MuteUserRequest:
      nullable: true
      properties:
        target_ids:
          description: User IDs to mute (if multiple users)
          items:
            type: string
          maximum: 1000
          title: Target IDs
          type: array
          x-stream-index: "002"
        timeout:
          description: Duration of mute in minutes
          minimum: 0
          title: Timeout
          type: integer
          x-stream-index: "003"
      required:
      - timeout
      type: object
    MuteUserResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "005.001"
        mute:
          $ref: '#/components/schemas/UserMuteResponse'
          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/UserMuteResponse'
          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/OwnUserResponse'
          description: Authorized user object with fresh mutes information
          title: Own user
          x-stream-index: "003"
      required:
      - duration
      type: object
    NotificationAddedToChannelEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003.004"
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "003.005"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "001.001"
        type:
          default: notification.added_to_channel
          type: string
          x-stream-index: "002.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationAddedToChannelEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationChannelDeletedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003.004"
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "003.005"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        team:
          type: string
          x-stream-index: "001.001"
        type:
          default: notification.channel_deleted
          type: string
          x-stream-index: "002.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationChannelDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationChannelMutesUpdatedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        me:
          $ref: '#/components/schemas/OwnUser'
          x-stream-index: "001"
        type:
          default: notification.channel_mutes_updated
          type: string
          x-stream-index: "002.001"
      required:
      - me
      - type
      - created_at
      title: NotificationChannelMutesUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationChannelTruncatedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002.004"
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "002.005"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        type:
          default: notification.channel_truncated
          type: string
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationChannelTruncatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationInviteAcceptedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002.004"
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "002.005"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "004.001"
        type:
          default: notification.invite_accepted
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationInviteAcceptedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationInviteRejectedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002.004"
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "002.005"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "004.001"
        type:
          default: notification.invite_rejected
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationInviteRejectedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationInvitedEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002.004"
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "002.005"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "004.001"
        type:
          default: notification.invited
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationInvitedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationMarkReadEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003.004"
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "003.005"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        team:
          type: string
          x-stream-index: "002.001"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "006"
        type:
          default: notification.mark_read
          type: string
          x-stream-index: "001.001"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "007"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "005"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "008"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "004.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      - unread_count
      - total_unread_count
      - unread_channels
      - unread_threads
      title: NotificationMarkReadEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationMarkUnreadEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003.004"
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "003.005"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        first_unread_message_id:
          type: string
          x-stream-index: "005"
        last_read_at:
          format: date-time
          type: string
          x-stream-index: "006"
        last_read_message_id:
          type: string
          x-stream-index: "012"
        team:
          type: string
          x-stream-index: "002.001"
        thread_id:
          type: string
          x-stream-index: "013"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "009"
        type:
          default: notification.mark_unread
          type: string
          x-stream-index: "001.001"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "010"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "008"
        unread_messages:
          format: int32
          type: integer
          x-stream-index: "007"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "011"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "004.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      - first_unread_message_id
      - last_read_at
      - unread_messages
      - unread_count
      - total_unread_count
      - unread_channels
      - unread_threads
      title: NotificationMarkUnreadEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationMutesUpdatedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        me:
          $ref: '#/components/schemas/OwnUser'
          x-stream-index: "001"
        type:
          default: notification.mutes_updated
          type: string
          x-stream-index: "002.001"
      required:
      - me
      - type
      - created_at
      title: NotificationMutesUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationNewMessageEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "004.004"
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "004.005"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001"
        team:
          type: string
          x-stream-index: "002.001"
        type:
          default: notification.message_new
          type: string
          x-stream-index: "003.001"
      required:
      - message
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationNewMessageEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    NotificationRemovedFromChannelEvent:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002.004"
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: "002.005"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.002"
        member:
          $ref: '#/components/schemas/ChannelMember'
          x-stream-index: "004.001"
        type:
          default: notification.removed_from_channel
          type: string
          x-stream-index: "001.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      - channel_member_count
      title: NotificationRemovedFromChannelEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    OnlyUserID:
      properties:
        id:
          type: string
          x-stream-index: "001"
      required:
      - id
      type: object
    OwnUser:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "047"
        banned:
          type: boolean
          x-stream-index: "016"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "046"
        channel_mutes:
          items:
            $ref: '#/components/schemas/ChannelMute'
          type: array
          x-stream-index: "029"
        created_at:
          format: date-time
          type: string
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        deactivated_at:
          format: date-time
          type: string
          x-stream-index: "014"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "013"
        devices:
          items:
            $ref: '#/components/schemas/Device'
          type: array
          x-stream-index: "027"
        id:
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "023"
        language:
          type: string
          x-stream-index: "035"
        last_active:
          format: date-time
          type: string
          x-stream-index: "011"
        last_engaged_at:
          format: date-time
          type: string
          x-stream-index: "012"
        latest_hidden_channels:
          items:
            type: string
          type: array
          x-stream-index: "037"
        mutes:
          items:
            $ref: '#/components/schemas/UserMute'
          type: array
          x-stream-index: "028"
        online:
          type: boolean
          x-stream-index: "022"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettings'
          x-stream-index: "026"
        push_preferences:
          $ref: '#/components/schemas/PushPreferences'
          x-stream-index: "025"
        role:
          type: string
          x-stream-index: "004"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "036"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "005"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "031"
        total_unread_count_by_team:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "032"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "033"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "030"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "034"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "009"
      required:
      - id
      - role
      - custom
      - created_at
      - updated_at
      - banned
      - online
      - devices
      - mutes
      - channel_mutes
      - unread_count
      - total_unread_count
      - total_unread_count_by_team
      - unread_channels
      - unread_threads
      - language
      type: object
    OwnUserResponse:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        banned:
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "015"
        channel_mutes:
          items:
            $ref: '#/components/schemas/ChannelMute'
          type: array
          x-stream-index: "007"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          format: date-time
          type: string
          x-stream-index: "001.016"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "001.011"
        devices:
          items:
            $ref: '#/components/schemas/DeviceResponse'
          title: Devices
          type: array
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: "001.001"
        image:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "005"
        language:
          type: string
          x-stream-index: "001.005"
        last_active:
          format: date-time
          type: string
          x-stream-index: "001.014"
        latest_hidden_channels:
          items:
            type: string
          type: array
          x-stream-index: "013"
        mutes:
          items:
            $ref: '#/components/schemas/UserMuteResponse'
          type: array
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "001.002"
        online:
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "003"
        push_preferences:
          $ref: '#/components/schemas/PushPreferencesResponse'
          x-stream-index: "002"
        revoke_tokens_issued_before:
          format: date-time
          type: string
          x-stream-index: "001.015"
        role:
          type: string
          x-stream-index: "001.006"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "009"
        total_unread_count_by_team:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "010"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "011"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "008"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "012"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - devices
      - invisible
      - mutes
      - channel_mutes
      - unread_count
      - total_unread_count
      - unread_channels
      - unread_threads
      type: object
    PaginationParams:
      properties:
        limit:
          format: int32
          minimum: 0
          type: integer
          x-stream-index: "001"
        offset:
          format: int32
          type: integer
          x-stream-index: "002"
      type: object
    PendingMessageEvent:
      description: Pending message event for async moderation
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
          x-stream-index: "002.007"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        message:
          $ref: '#/components/schemas/Message'
          description: The pending message
          title: Message
          x-stream-index: "002.009"
        metadata:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "002.010"
        method:
          description: The method used for the pending message
          title: Method
          type: string
          x-stream-index: "003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        type:
          default: message.pending
          description: 'The type of event: "message.pending" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.002"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002.002"
      required:
      - type
      - custom
      - method
      - created_at
      title: PendingMessageEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PendingMessageResponse:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "002"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "003"
        metadata:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "004"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
      type: object
    Poll:
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "023"
        allow_answers:
          type: boolean
          x-stream-index: "010"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "009"
        answers_count:
          format: int32
          type: integer
          x-stream-index: "015"
        created_at:
          format: date-time
          type: string
          x-stream-index: "021"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "020"
        created_by_id:
          type: string
          x-stream-index: "019"
        description:
          type: string
          x-stream-index: "005"
        enforce_unique_vote:
          type: boolean
          x-stream-index: "007"
        id:
          type: string
          x-stream-index: "003"
        is_closed:
          type: boolean
          x-stream-index: "011"
        latest_answers:
          items:
            $ref: '#/components/schemas/PollVote'
          type: array
          x-stream-index: "017"
        latest_votes_by_option:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PollVote'
            type: array
          type: object
          x-stream-index: "016"
        max_votes_allowed:
          format: int32
          type: integer
          x-stream-index: "008"
        name:
          type: string
          x-stream-index: "004"
        options:
          items:
            $ref: '#/components/schemas/PollOption'
          type: array
          x-stream-index: "013"
        own_votes:
          items:
            $ref: '#/components/schemas/PollVote'
          type: array
          x-stream-index: "018"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "022"
        vote_count:
          format: int32
          type: integer
          x-stream-index: "012"
        vote_counts_by_option:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "014"
        voting_visibility:
          type: string
          x-stream-index: "006"
      required:
      - id
      - name
      - description
      - enforce_unique_vote
      - allow_user_suggested_options
      - allow_answers
      - vote_count
      - options
      - vote_counts_by_option
      - answers_count
      - latest_votes_by_option
      - latest_answers
      - own_votes
      - created_by_id
      - created_at
      - updated_at
      - Custom
      type: object
    PollClosedEvent:
      description: Emitted when a poll is closed.
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: "001.003"
        cid:
          description: The CID of the channel containing the poll
          title: Channel CID
          type: string
          x-stream-index: 001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.007
        message_id:
          description: The ID of the message containing the poll
          title: Message ID
          type: string
          x-stream-index: "001.002"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: The poll object which was closed
          title: Poll
          x-stream-index: "001.004"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.004
        type:
          default: poll.closed
          description: 'The type of event: "poll.closed" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.002
      required:
      - type
      - created_at
      - custom
      - poll
      title: PollClosedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PollDeletedEvent:
      description: Emitted when a poll is deleted.
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: "001.003"
        cid:
          description: The CID of the channel containing the poll
          title: Channel CID
          type: string
          x-stream-index: 001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.007
        message_id:
          description: The ID of the message containing the poll
          title: Message ID
          type: string
          x-stream-index: "001.002"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: The poll object which was deleted
          title: Poll
          x-stream-index: "001.004"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.004
        type:
          default: poll.deleted
          description: 'The type of event: "poll.deleted" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.002
      required:
      - type
      - created_at
      - custom
      - poll
      title: PollDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PollOption:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      - text
      - custom
      type: object
    PollOptionInput:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        text:
          type: string
          x-stream-index: "002"
      type: object
    PollOptionRequest:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      type: object
    PollOptionResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        poll_option:
          $ref: '#/components/schemas/PollOptionResponseData'
          description: Poll option
          title: PollOptionResponseData
          x-stream-index: "001"
      required:
      - poll_option
      - duration
      type: object
    PollOptionResponseData:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      - text
      - custom
      type: object
    PollResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: Poll
          title: PollResponseData
          x-stream-index: "001"
      required:
      - poll
      - duration
      type: object
    PollResponseData:
      properties:
        allow_answers:
          type: boolean
          x-stream-index: "008"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "007"
        answers_count:
          format: int32
          type: integer
          x-stream-index: "012"
        created_at:
          format: date-time
          type: string
          x-stream-index: "019"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "018"
        created_by_id:
          type: string
          x-stream-index: "017"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "021"
        description:
          type: string
          x-stream-index: "003"
        enforce_unique_vote:
          type: boolean
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        is_closed:
          type: boolean
          x-stream-index: "009"
        latest_answers:
          items:
            $ref: '#/components/schemas/PollVoteResponseData'
          type: array
          x-stream-index: "015"
        latest_votes_by_option:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PollVoteResponseData'
            type: array
          type: object
          x-stream-index: "014"
        max_votes_allowed:
          format: int32
          type: integer
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "002"
        options:
          items:
            $ref: '#/components/schemas/PollOptionResponseData'
          type: array
          x-stream-index: "011"
        own_votes:
          items:
            $ref: '#/components/schemas/PollVoteResponseData'
          type: array
          x-stream-index: "016"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "020"
        vote_count:
          format: int32
          type: integer
          x-stream-index: "010"
        vote_counts_by_option:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "013"
        voting_visibility:
          type: string
          x-stream-index: "004"
      required:
      - id
      - name
      - description
      - voting_visibility
      - enforce_unique_vote
      - allow_user_suggested_options
      - allow_answers
      - vote_count
      - options
      - answers_count
      - vote_counts_by_option
      - latest_votes_by_option
      - latest_answers
      - own_votes
      - created_by_id
      - created_at
      - updated_at
      - custom
      type: object
    PollUpdatedEvent:
      description: Emitted when a poll is updated.
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: "001.003"
        cid:
          description: The CID of the channel containing the poll
          title: Channel CID
          type: string
          x-stream-index: 001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.007
        message_id:
          description: The ID of the message containing the poll
          title: Message ID
          type: string
          x-stream-index: "001.002"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: The poll object which was updated
          title: Poll
          x-stream-index: "001.004"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.004
        type:
          default: poll.updated
          description: 'The type of event: "poll.updated" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.002
      required:
      - type
      - created_at
      - custom
      - poll
      title: PollUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PollVote:
      nullable: true
      properties:
        answer_text:
          type: string
          x-stream-index: "007"
        created_at:
          format: date-time
          type: string
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "004"
        is_answer:
          type: boolean
          x-stream-index: "006"
        option_id:
          type: string
          x-stream-index: "005"
        poll_id:
          type: string
          x-stream-index: "003"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "011"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "009"
        user_id:
          type: string
          x-stream-index: "008"
      required:
      - poll_id
      - id
      - option_id
      - created_at
      - updated_at
      type: object
    PollVoteCastedEvent:
      description: Emitted when a vote is cast on a poll.
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: 001.001.003
        cid:
          description: The CID of the channel containing the poll
          title: Channel CID
          type: string
          x-stream-index: 001.001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.001.007
        message_id:
          description: The ID of the message containing the poll
          title: Message ID
          type: string
          x-stream-index: 001.001.002
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: The poll object
          title: Poll
          x-stream-index: 001.001.004
        poll_vote:
          $ref: '#/components/schemas/PollVoteResponseData'
          description: The vote that was cast
          title: Poll Vote
          x-stream-index: "001.002"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.001.004
        type:
          default: poll.vote_casted
          description: 'The type of event: "poll.vote_casted" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.001.002
      required:
      - type
      - created_at
      - custom
      - poll
      - poll_vote
      title: PollVoteCastedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PollVoteChangedEvent:
      description: Emitted when a vote on a poll is changed.
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: 001.001.003
        cid:
          description: The CID of the channel containing the poll
          title: Channel CID
          type: string
          x-stream-index: 001.001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.001.007
        message_id:
          description: The ID of the message containing the poll
          title: Message ID
          type: string
          x-stream-index: 001.001.002
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: The poll object
          title: Poll
          x-stream-index: 001.001.004
        poll_vote:
          $ref: '#/components/schemas/PollVoteResponseData'
          description: The updated vote
          title: Poll Vote
          x-stream-index: "001.002"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.001.004
        type:
          default: poll.vote_changed
          description: 'The type of event: "poll.vote_changed" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.001.002
      required:
      - type
      - created_at
      - custom
      - poll
      - poll_vote
      title: PollVoteChangedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PollVoteRemovedEvent:
      description: Emitted when a vote is removed from a poll.
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: 001.001.003
        cid:
          description: The CID of the channel containing the poll
          title: Channel CID
          type: string
          x-stream-index: 001.001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.001.007
        message_id:
          description: The ID of the message containing the poll
          title: Message ID
          type: string
          x-stream-index: 001.001.002
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: The poll object
          title: Poll
          x-stream-index: 001.001.004
        poll_vote:
          $ref: '#/components/schemas/PollVoteResponseData'
          description: The vote that was removed
          title: Poll Vote
          x-stream-index: "001.002"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.001.004
        type:
          default: poll.vote_removed
          description: 'The type of event: "poll.vote_removed" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.001.002
      required:
      - type
      - created_at
      - custom
      - poll
      - poll_vote
      title: PollVoteRemovedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    PollVoteResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: Poll
          title: PollResponseData
          x-stream-index: "002"
        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:
        delivery_receipts:
          $ref: '#/components/schemas/DeliveryReceipts'
          x-stream-index: "003"
        read_receipts:
          $ref: '#/components/schemas/ReadReceipts'
          x-stream-index: "002"
        typing_indicators:
          $ref: '#/components/schemas/TypingIndicators'
          x-stream-index: "001"
      type: object
    PrivacySettingsResponse:
      properties:
        delivery_receipts:
          $ref: '#/components/schemas/DeliveryReceiptsResponse'
          x-stream-index: "003"
        read_receipts:
          $ref: '#/components/schemas/ReadReceiptsResponse'
          x-stream-index: "002"
        typing_indicators:
          $ref: '#/components/schemas/TypingIndicatorsResponse'
          x-stream-index: "001"
      type: object
    PushPreferenceInput:
      nullable: true
      properties:
        call_level:
          description: Set the level of call push notifications for the user. One
            of all, none, default
          enum:
          - all
          - none
          - default
          type: string
          x-stream-index: "004"
        channel_cid:
          description: Set the push preferences for a specific channel. If empty it
            sets the default for the user
          type: string
          x-stream-index: "002"
        chat_level:
          description: Set the level of chat push notifications for the user. One
            of all, mentions, none, default
          enum:
          - all
          - mentions
          - none
          - default
          type: string
          x-stream-index: "003"
        disabled_until:
          description: Disable push notifications till a certain time
          format: date-time
          type: string
          x-stream-index: "007"
        feeds_level:
          description: Set the level of feeds push notifications for the user. One
            of all, none, default
          enum:
          - all
          - none
          - default
          type: string
          x-stream-index: "005"
        feeds_preferences:
          $ref: '#/components/schemas/FeedsPreferences'
          description: Set granular feeds preferences for reactions, comments, new
            followers, mentions, and custom activity types
          x-stream-index: "006"
        remove_disable:
          description: Remove the disabled until time. (IE stop snoozing notifications)
          type: boolean
          x-stream-index: "008"
        user_id:
          description: The user id for which to set the push preferences. Required
            when using server side auths, defaults to current user with client side
            auth.
          type: string
          x-stream-index: "001"
      type: object
    PushPreferences:
      properties:
        call_level:
          type: string
          x-stream-index: "002"
        chat_level:
          type: string
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: string
          x-stream-index: "005"
        feeds_level:
          type: string
          x-stream-index: "003"
        feeds_preferences:
          $ref: '#/components/schemas/FeedsPreferences'
          x-stream-index: "004"
      type: object
    PushPreferencesResponse:
      properties:
        call_level:
          type: string
          x-stream-index: "002"
        chat_level:
          type: string
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: string
          x-stream-index: "005"
        feeds_level:
          type: string
          x-stream-index: "003"
        feeds_preferences:
          $ref: '#/components/schemas/FeedsPreferencesResponse'
          x-stream-index: "004"
      type: object
    QueryBannedUsersPayload:
      properties:
        exclude_expired_bans:
          description: Whether to exclude expired bans or not
          title: Exclude expired bans
          type: boolean
          x-stream-index: "004"
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
        limit:
          description: Number of records to return
          format: int32
          maximum: 300
          minimum: 0
          title: Limit
          type: integer
          x-stream-index: "003.003"
        offset:
          description: Number of records to offset
          format: int32
          maximum: 10000
          title: Offset
          type: integer
          x-stream-index: "003.004"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 1
          title: Sort
          type: array
          x-stream-index: "002"
      required:
      - filter_conditions
      type: object
    QueryBannedUsersResponse:
      nullable: true
      properties:
        bans:
          description: List of found bans
          items:
            $ref: '#/components/schemas/BanResponse'
          title: BanResponse
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - bans
      - duration
      type: object
    QueryChannelsRequest:
      nullable: true
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
        limit:
          description: Number of channels to limit
          format: int32
          title: Limit
          type: integer
          x-stream-index: "008"
        member_limit:
          description: Number of members to limit
          format: int32
          maximum: 100
          minimum: 0
          title: Member limit
          type: integer
          x-stream-index: "007"
        message_limit:
          description: Number of messages to limit
          format: int32
          minimum: 0
          title: Message limit
          type: integer
          x-stream-index: "006"
        offset:
          description: Channel pagination offset
          format: int32
          title: Offset
          type: integer
          x-stream-index: "009"
        presence:
          title: Presence
          type: boolean
          x-stream-index: "005"
        sort:
          description: List of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "002"
        state:
          description: Whether to update channel state or not
          title: State
          type: boolean
          x-stream-index: "004"
        watch:
          description: Whether to start watching found channels or not
          title: Watch
          type: boolean
          x-stream-index: "003"
      title: Query Channels Request
      type: object
      x-stream-docs-page-id: query_channels
    QueryChannelsResponse:
      nullable: true
      properties:
        channels:
          description: List of channels
          items:
            $ref: '#/components/schemas/ChannelStateResponseFields'
          title: Channels
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - channels
      - duration
      title: Channels list
      type: object
    QueryDraftsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter to apply to the query
          maximum: 3
          title: Filter
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.001"
        next:
          type: string
          x-stream-index: "005.002"
        prev:
          type: string
          x-stream-index: "005.003"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "002"
      type: object
    QueryDraftsResponse:
      nullable: true
      properties:
        drafts:
          description: Drafts
          items:
            $ref: '#/components/schemas/DraftResponse'
          title: DraftsResponseList
          type: array
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - drafts
      - duration
      type: object
    QueryMembersPayload:
      description: Client request
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: "002"
        limit:
          format: int32
          maximum: 300
          minimum: 0
          type: integer
          x-stream-index: "006.003"
        members:
          items:
            $ref: '#/components/schemas/ChannelMemberRequest'
          maximum: 100
          type: array
          x-stream-index: "003"
        offset:
          format: int32
          maximum: 10000
          type: integer
          x-stream-index: "006.004"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 1
          type: array
          x-stream-index: "005"
        type:
          maxLength: 64
          type: string
          x-stream-index: "001"
      required:
      - type
      - filter_conditions
      title: ClientRequest
      type: object
    QueryMessageFlagsPayload:
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 300
          minimum: 0
          type: integer
          x-stream-index: "003.003"
        offset:
          format: int32
          maximum: 10000
          type: integer
          x-stream-index: "003.004"
        show_deleted_messages:
          description: Whether to include deleted messages in the results
          title: ShowDeletedMessages
          type: boolean
          x-stream-index: "002"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          type: array
          x-stream-index: "003.005"
      type: object
    QueryMessageFlagsResponse:
      description: Query message flags response
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        flags:
          description: The flags that match the query
          items:
            $ref: '#/components/schemas/MessageFlagResponse'
          title: MessageFlagResponseList
          type: array
          x-stream-index: "001"
      required:
      - flags
      - duration
      title: QueryMessageFlagsResponse
      type: object
    QueryPollVotesRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter to apply to the query
          title: Filter
          type: object
          x-stream-index: "003"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.001"
        next:
          type: string
          x-stream-index: "005.002"
        prev:
          type: string
          x-stream-index: "005.003"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "004"
      type: object
    QueryPollsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter to apply to the query
          title: Filter
          type: object
          x-stream-index: "002"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.001"
        next:
          type: string
          x-stream-index: "005.002"
        prev:
          type: string
          x-stream-index: "005.003"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "003"
      type: object
    QueryPollsResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        polls:
          description: Polls data returned by the query
          items:
            $ref: '#/components/schemas/PollResponseData'
          title: PollsResponseData
          type: array
          x-stream-index: "001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - polls
      - duration
      type: object
    QueryReactionsRequest:
      properties:
        filter:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "006.001"
        next:
          type: string
          x-stream-index: "006.002"
        prev:
          type: string
          x-stream-index: "006.003"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 2
          type: array
          x-stream-index: "003"
      type: object
    QueryReactionsResponse:
      description: Basic response information
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        next:
          type: string
          x-stream-index: "003.001"
        prev:
          type: string
          x-stream-index: "003.002"
        reactions:
          items:
            $ref: '#/components/schemas/ReactionResponse'
          type: array
          x-stream-index: "001"
      required:
      - reactions
      - duration
      title: Response
      type: object
    QueryRemindersRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter to apply to the query
          title: Filter
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.001"
        next:
          type: string
          x-stream-index: "005.002"
        prev:
          type: string
          x-stream-index: "005.003"
        sort:
          description: Array of sort parameters
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "002"
      type: object
    QueryRemindersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
        reminders:
          description: MessageReminders data returned by the query
          items:
            $ref: '#/components/schemas/ReminderResponseData'
          title: RemindersResponseData
          type: array
          x-stream-index: "001"
      required:
      - reminders
      - duration
      type: object
    QueryThreadsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter conditions to apply to threads
          title: Filter
          type: object
          x-stream-index: "006"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "008.001"
        member_limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005"
        next:
          type: string
          x-stream-index: "008.002"
        participant_limit:
          description: Limit the number of participants returned per each thread
          format: int32
          maximum: 100
          minimum: 0
          title: Participant limit
          type: integer
          x-stream-index: "004"
        prev:
          type: string
          x-stream-index: "008.003"
        reply_limit:
          description: Limit the number of replies returned per each thread
          format: int32
          maximum: 10
          minimum: 0
          title: Reply limit
          type: integer
          x-stream-index: "003"
        sort:
          description: Sort conditions to apply to threads
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          title: Sort
          type: array
          x-stream-index: "007"
        watch:
          description: Start watching the channel this thread belongs to
          title: Watch
          type: boolean
          x-stream-index: "001"
      type: object
    QueryThreadsResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
        threads:
          description: List of enriched thread states
          items:
            $ref: '#/components/schemas/ThreadStateResponse'
          title: Threads
          type: array
          x-stream-index: "001"
      required:
      - threads
      - duration
      type: object
    QueryUsersPayload:
      properties:
        filter_conditions:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
        include_deactivated_users:
          type: boolean
          x-stream-index: "004"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "005.003"
        offset:
          format: int32
          maximum: 1000
          type: integer
          x-stream-index: "005.004"
        presence:
          type: boolean
          x-stream-index: "003"
        sort:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 5
          type: array
          x-stream-index: "002"
      required:
      - filter_conditions
      type: object
    QueryUsersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        users:
          description: Array of users as result of filters applied.
          items:
            $ref: '#/components/schemas/FullUserResponse'
          title: Users
          type: array
          x-stream-index: "001"
      required:
      - users
      - duration
      type: object
    Reaction:
      nullable: true
      properties:
        created_at:
          format: date-time
          readOnly: true
          type: string
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        message_id:
          type: string
          x-stream-index: "003"
        score:
          format: int32
          type: integer
          x-stream-index: "007"
        type:
          maxLength: 30
          type: string
          x-stream-index: "006"
        updated_at:
          format: date-time
          readOnly: true
          type: string
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005"
        user_id:
          type: string
          x-stream-index: "004"
      required:
      - message_id
      - type
      - score
      - created_at
      - updated_at
      - custom
      type: object
    ReactionDeletedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "006.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001.001"
        reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "002"
        team:
          type: string
          x-stream-index: "005.001"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "001.002"
        type:
          default: reaction.deleted
          type: string
          x-stream-index: "006.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "004.001"
      required:
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: ReactionDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReactionGroupResponse:
      description: ReactionGroupResponse contains all information about a reaction
        of the same type.
      nullable: true
      properties:
        count:
          description: Count is the number of reactions of this type.
          format: int32
          title: Count
          type: integer
          x-stream-index: "001"
        first_reaction_at:
          description: FirstReactionAt is the time of the first reaction of this type.
            This is the same also if all reaction of this type are deleted, because
            if someone will react again with the same type, will be preserved the
            sorting.
          format: date-time
          title: FirstReactionAt
          type: string
          x-stream-index: "003"
        last_reaction_at:
          description: LastReactionAt is the time of the last reaction of this type.
          format: date-time
          title: LastReactionAt
          type: string
          x-stream-index: "004"
        sum_scores:
          description: 'SumScores is the sum of all scores of reactions of this type.
            Medium allows you to clap articles more than once and shows the sum of
            all claps from all users. For example, you can send `clap` x5 using `score:
            5`.'
          format: int32
          title: SumScores
          type: integer
          x-stream-index: "002"
      required:
      - count
      - sum_scores
      - first_reaction_at
      - last_reaction_at
      title: ReactionGroupResponse
      type: object
    ReactionNewEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "006.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001.001"
        reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "002"
        team:
          type: string
          x-stream-index: "005.001"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "001.002"
        type:
          default: reaction.new
          type: string
          x-stream-index: "006.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: ReactionNewEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReactionRequest:
      description: Represents user reaction to a message
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "005"
        score:
          description: Reaction score. If not specified reaction has score of 1
          format: int32
          title: Score
          type: integer
          x-stream-index: "002"
        type:
          description: The type of reaction (e.g. 'like', 'laugh', 'wow')
          maxLength: 30
          title: Type
          type: string
          x-stream-index: "001"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "004"
      required:
      - type
      title: Reaction
      type: object
      x-stream-docs-page-id: send_reaction
    ReactionResponse:
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "008"
        message_id:
          description: Message ID
          title: Message ID
          type: string
          x-stream-index: "001"
        score:
          description: Score of the reaction
          format: int32
          title: Score
          type: integer
          x-stream-index: "005"
        type:
          description: Type of reaction
          title: Type
          type: string
          x-stream-index: "004"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User
          title: UserResponse
          x-stream-index: "003"
        user_id:
          description: User ID
          title: User ID
          type: string
          x-stream-index: "002"
      required:
      - message_id
      - user_id
      - user
      - type
      - score
      - created_at
      - updated_at
      - custom
      type: object
    ReactionUpdatedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "006.002"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "001"
        reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "002"
        team:
          type: string
          x-stream-index: "005.001"
        type:
          default: reaction.updated
          type: string
          x-stream-index: "006.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - message
      - reaction
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: ReactionUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReadReceipts:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    ReadReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    ReadStateResponse:
      properties:
        last_delivered_at:
          format: date-time
          type: string
          x-stream-index: "005"
        last_delivered_message_id:
          type: string
          x-stream-index: "006"
        last_read:
          format: date-time
          type: string
          x-stream-index: "002"
        last_read_message_id:
          type: string
          x-stream-index: "004"
        unread_messages:
          format: int32
          type: integer
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
      required:
      - user
      - last_read
      - unread_messages
      type: object
    ReminderCreatedEvent:
      description: Emitted when a reminder is created.
      nullable: true
      properties:
        cid:
          description: The CID of the Channel for which the reminder was created
          title: Channel CID
          type: string
          x-stream-index: "001.004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.007
        message_id:
          description: The ID of the message for which the reminder was created
          title: Message ID
          type: string
          x-stream-index: "001.002"
        parent_id:
          description: The ID of the parent message, if the reminder is for a thread
            message
          title: Parent ID
          type: string
          x-stream-index: "001.005"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.004
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          description: The reminder object which was created
          title: MessageReminder
          x-stream-index: "001.006"
        type:
          default: reminder.created
          description: 'The type of event: "reminder.created" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.002
        user_id:
          description: The ID of the user for whom the reminder was created
          title: User ID
          type: string
          x-stream-index: "001.003"
      required:
      - type
      - created_at
      - custom
      - message_id
      - user_id
      - cid
      title: ReminderCreatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReminderDeletedEvent:
      description: Emitted when a reminder is deleted.
      nullable: true
      properties:
        cid:
          description: The CID of the Channel for which the reminder was created
          title: Channel CID
          type: string
          x-stream-index: "001.004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.007
        message_id:
          description: The ID of the message for which the reminder was created
          title: Message ID
          type: string
          x-stream-index: "001.002"
        parent_id:
          description: The ID of the parent message, if the reminder is for a thread
            message
          title: Parent ID
          type: string
          x-stream-index: "001.005"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.004
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          description: The reminder object which was created
          title: MessageReminder
          x-stream-index: "001.006"
        type:
          default: reminder.deleted
          description: 'The type of event: "reminder.deleted" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.002
        user_id:
          description: The ID of the user for whom the reminder was created
          title: User ID
          type: string
          x-stream-index: "001.003"
      required:
      - type
      - created_at
      - custom
      - message_id
      - user_id
      - cid
      title: ReminderDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReminderNotificationEvent:
      description: Emitted when a reminder becomes due, triggering a notification
        for the user.
      nullable: true
      properties:
        cid:
          description: The CID of the Channel for which the reminder was created
          title: Channel CID
          type: string
          x-stream-index: "001.004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.007
        message_id:
          description: The ID of the message for which the reminder was created
          title: Message ID
          type: string
          x-stream-index: "001.002"
        parent_id:
          type: string
          x-stream-index: "001.005"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.004
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          description: The reminder object which was created
          title: MessageReminder
          x-stream-index: "001.006"
        type:
          default: notification.reminder_due
          description: 'The type of event: "notification.reminder_due" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.002
        user_id:
          description: The ID of the user for whom the reminder was created
          title: User ID
          type: string
          x-stream-index: "001.003"
      required:
      - type
      - created_at
      - custom
      - message_id
      - user_id
      - cid
      title: ReminderNotificationEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReminderResponseData:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003"
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "008"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "005"
        message_id:
          type: string
          x-stream-index: "004"
        remind_at:
          format: date-time
          type: string
          x-stream-index: "001"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "007"
        user_id:
          type: string
          x-stream-index: "006"
      required:
      - channel_cid
      - message_id
      - user_id
      - created_at
      - updated_at
      type: object
    ReminderUpdatedEvent:
      description: Emitted when a reminder is updated.
      nullable: true
      properties:
        cid:
          description: The CID of the Channel for which the reminder was created
          title: Channel CID
          type: string
          x-stream-index: "001.004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.007
        message_id:
          description: The ID of the message for which the reminder was created
          title: Message ID
          type: string
          x-stream-index: "001.002"
        parent_id:
          description: The ID of the parent message, if the reminder is for a thread
            message
          title: Parent ID
          type: string
          x-stream-index: "001.005"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.004
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          description: The reminder object which was created
          title: MessageReminder
          x-stream-index: "001.006"
        type:
          default: reminder.updated
          description: 'The type of event: "reminder.updated" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.002
        user_id:
          description: The ID of the user for whom the reminder was created
          title: User ID
          type: string
          x-stream-index: "001.003"
      required:
      - type
      - created_at
      - custom
      - message_id
      - user_id
      - cid
      title: ReminderUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    Response:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001"
      required:
      - duration
      title: Response
      type: object
    SearchPayload:
      properties:
        filter_conditions:
          additionalProperties: {}
          description: Channel filter conditions
          maximum: 100
          minimum: 1
          title: Channel filter
          type: object
          x-stream-docs-page-id: query_channels
          x-stream-index: "002"
        force_default_search:
          type: boolean
          x-stream-index: "010"
        force_sql_v2_backend:
          type: boolean
          x-stream-index: "011"
        limit:
          description: Number of messages to return
          format: int32
          title: Limit
          type: integer
          x-stream-index: "005"
        message_filter_conditions:
          additionalProperties: {}
          description: Message filter conditions
          title: Message filter
          type: object
          x-stream-index: "003"
        message_options:
          $ref: '#/components/schemas/MessageOptions'
          x-stream-index: "004"
        next:
          description: Pagination parameter. Cannot be used with non-zero offset.
          title: Next
          type: string
          x-stream-index: "008"
        offset:
          description: Pagination offset. Cannot be used with sort or next.
          format: int32
          title: Offset
          type: integer
          x-stream-index: "006"
        query:
          description: Search phrase
          title: Query
          type: string
          x-stream-index: "001"
        sort:
          description: Sort parameters. Cannot be used with non-zero offset
          items:
            $ref: '#/components/schemas/SortParamRequest'
          title: Sort
          type: array
          x-stream-index: "007"
      required:
      - filter_conditions
      type: object
    SearchResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "005.001"
        next:
          description: Value to pass to the next search query in order to paginate
          title: Next
          type: string
          x-stream-index: "003"
        previous:
          description: Value that points to the previous page. Pass as the next value
            in a search query to paginate backwards
          title: Previous
          type: string
          x-stream-index: "004"
        results:
          description: Search results
          items:
            $ref: '#/components/schemas/SearchResult'
          title: Results
          type: array
          x-stream-index: "001"
        results_warning:
          $ref: '#/components/schemas/SearchWarning'
          description: Warning about the search results
          title: Results Warning
          x-stream-index: "002"
      required:
      - results
      - duration
      type: object
    SearchResult:
      properties:
        message:
          $ref: '#/components/schemas/SearchResultMessage'
          description: Found message
          title: Message
          x-stream-index: "001"
      type: object
    SearchResultMessage:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "001.009"
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Channel object
          title: Channel
          x-stream-index: "002"
        cid:
          type: string
          x-stream-index: "001.023"
        command:
          type: string
          x-stream-index: "001.004"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.024"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.027"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "001.026"
        deleted_for_me:
          type: boolean
          x-stream-index: "001.045"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "001.019"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "001.042"
        html:
          type: string
          x-stream-index: "001.005"
        i18n:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.031"
        id:
          type: string
          x-stream-index: "001.001"
        image_labels:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "001.029"
        latest_reactions:
          items:
            $ref: '#/components/schemas/ReactionResponse'
          type: array
          x-stream-index: "001.010"
        member:
          $ref: '#/components/schemas/ChannelMemberResponse'
          x-stream-index: "001.008"
        mentioned_users:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "001.030"
        message_text_updated_at:
          format: date-time
          type: string
          x-stream-index: "001.037"
        mml:
          type: string
          x-stream-index: "001.003"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "001.040"
        own_reactions:
          items:
            $ref: '#/components/schemas/ReactionResponse'
          type: array
          x-stream-index: "001.011"
        parent_id:
          type: string
          x-stream-index: "001.016"
        pin_expires:
          format: date-time
          type: string
          x-stream-index: "001.036"
        pinned:
          type: boolean
          x-stream-index: "001.033"
        pinned_at:
          format: date-time
          type: string
          x-stream-index: "001.034"
        pinned_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001.035"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "001.039"
        poll_id:
          type: string
          x-stream-index: "001.038"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "001.021"
        quoted_message_id:
          type: string
          x-stream-index: "001.020"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "001.012"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "001.015"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "001.013"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "001.043"
        reply_count:
          format: int32
          type: integer
          x-stream-index: "001.018"
        restricted_visibility:
          items:
            type: string
          type: array
          x-stream-index: "001.041"
        shadowed:
          type: boolean
          x-stream-index: "001.028"
        shared_location:
          $ref: '#/components/schemas/SharedLocationResponseData'
          x-stream-index: "001.044"
        show_in_channel:
          type: boolean
          x-stream-index: "001.017"
        silent:
          type: boolean
          x-stream-index: "001.032"
        text:
          type: string
          x-stream-index: "001.002"
        thread_participants:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "001.022"
        type:
          type: string
          x-stream-index: "001.006"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "001.025"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001.007"
      required:
      - id
      - text
      - html
      - type
      - user
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - silent
      - pinned
      - restricted_visibility
      type: object
    SearchWarning:
      properties:
        channel_search_cids:
          description: Channel CIDs for the searched channels
          items:
            type: string
          title: Channel Search CIDs
          type: array
          x-stream-index: "004"
        channel_search_count:
          description: Number of channels searched
          format: int32
          title: Channel Search Count
          type: integer
          x-stream-index: "003"
        warning_code:
          description: Code corresponding to the warning
          format: int32
          title: Warning Code
          type: integer
          x-stream-index: "002"
        warning_description:
          description: Description of the warning
          title: Warning Description
          type: string
          x-stream-index: "001"
      required:
      - warning_description
      - warning_code
      type: object
    SendEventRequest:
      nullable: true
      properties:
        event:
          $ref: '#/components/schemas/EventRequest'
          x-stream-index: "001"
      required:
      - event
      type: object
    SendMessageRequest:
      nullable: true
      properties:
        keep_channel_hidden:
          type: boolean
          x-stream-index: "008"
        message:
          $ref: '#/components/schemas/MessageRequest'
          x-stream-index: "001"
        skip_enrich_url:
          type: boolean
          x-stream-index: "003"
        skip_push:
          type: boolean
          x-stream-index: "002"
      required:
      - message
      type: object
    SendMessageResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: Message response
          title: Message
          x-stream-index: "001"
        pending_message_metadata:
          additionalProperties:
            type: string
          description: Pending message metadata
          title: Pending message metadata
          type: object
          x-stream-index: "002"
      required:
      - message
      - duration
      type: object
    SendReactionRequest:
      nullable: true
      properties:
        enforce_unique:
          description: Whether to replace all existing user reactions
          title: Enforce unique
          type: boolean
          x-stream-index: "003"
        reaction:
          $ref: '#/components/schemas/ReactionRequest'
          x-stream-index: "002"
        skip_push:
          description: Skips any mobile push notifications
          title: Skip push
          type: boolean
          x-stream-index: "004"
      required:
      - reaction
      type: object
    SendReactionResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "001"
        reaction:
          $ref: '#/components/schemas/ReactionResponse'
          x-stream-index: "002"
      required:
      - message
      - reaction
      - duration
      title: Response
      type: object
    SharedLocation:
      properties:
        created_by_device_id:
          type: string
          x-stream-index: "003"
        end_at:
          format: date-time
          type: string
          x-stream-index: "004"
        latitude:
          format: float
          maximum: 90
          minimum: 1.8446744073709552e+19
          type: number
          x-stream-index: "001"
        longitude:
          format: float
          maximum: 180
          minimum: 1.8446744073709552e+19
          type: number
          x-stream-index: "002"
      required:
      - latitude
      - longitude
      type: object
    SharedLocationResponse:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "001.011"
        channel_cid:
          description: Channel CID
          title: string
          type: string
          x-stream-index: "001.001"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "001.008"
        created_by_device_id:
          description: Device ID that created the live location
          title: string
          type: string
          x-stream-index: "001.006"
        duration:
          type: string
          x-stream-index: "002.001"
        end_at:
          description: Time when the live location expires
          format: date-time
          title: string
          type: string
          x-stream-index: "001.007"
        latitude:
          description: Latitude coordinate
          format: float
          title: number
          type: number
          x-stream-index: "001.004"
        longitude:
          description: Longitude coordinate
          format: float
          title: number
          type: number
          x-stream-index: "001.005"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "001.010"
        message_id:
          description: Message ID
          title: string
          type: string
          x-stream-index: "001.002"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "001.009"
        user_id:
          description: User ID
          title: string
          type: string
          x-stream-index: "001.003"
      required:
      - channel_cid
      - message_id
      - user_id
      - latitude
      - longitude
      - created_by_device_id
      - created_at
      - updated_at
      - duration
      type: object
    SharedLocationResponseData:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "011"
        channel_cid:
          type: string
          x-stream-index: "001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "008"
        created_by_device_id:
          type: string
          x-stream-index: "006"
        end_at:
          format: date-time
          type: string
          x-stream-index: "007"
        latitude:
          format: float
          type: number
          x-stream-index: "004"
        longitude:
          format: float
          type: number
          x-stream-index: "005"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "010"
        message_id:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "009"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - channel_cid
      - message_id
      - user_id
      - latitude
      - longitude
      - created_by_device_id
      - created_at
      - updated_at
      type: object
    SharedLocationsResponse:
      nullable: true
      properties:
        active_live_locations:
          items:
            $ref: '#/components/schemas/SharedLocationResponseData'
          type: array
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - active_live_locations
      - duration
      type: object
    ShowChannelRequest:
      nullable: true
      type: object
    ShowChannelResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      title: Response
      type: object
    SortParamRequest:
      nullable: true
      properties:
        direction:
          description: Direction of sorting, 1 for Ascending, -1 for Descending, default
            is 1
          format: int32
          title: Direction
          type: integer
          x-stream-index: "003"
        field:
          description: Name of field to sort by
          title: Field
          type: string
          x-stream-index: "001"
        type:
          description: Type of field to sort by (default is string)
          enum:
          - ""
          - number
          - boolean
          title: Type
          type: string
          x-stream-index: "002"
      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
      - participant_count
      - active_participant_count
      - created_at
      - updated_at
      - title
      - custom
      type: object
    ThreadStateResponse:
      nullable: true
      properties:
        active_participant_count:
          description: Active Participant Count
          format: int32
          title: Active Participant Count
          type: integer
          x-stream-index: "001.009"
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Channel
          title: ChannelResponse
          x-stream-index: "001.002"
        channel_cid:
          description: Channel CID
          title: Channel CID
          type: string
          x-stream-index: "001.001"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "001.012"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: Created By User
          title: User
          x-stream-index: "001.006"
        created_by_user_id:
          description: Created By User ID
          title: Created By User ID
          type: string
          x-stream-index: "001.005"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "001.016"
        deleted_at:
          description: Deleted At
          format: date-time
          title: Deleted At
          type: string
          x-stream-index: "001.014"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "004"
        last_message_at:
          description: Last Message At
          format: date-time
          title: Last Message At
          type: string
          x-stream-index: "001.011"
        latest_replies:
          items:
            $ref: '#/components/schemas/MessageResponse'
          type: array
          x-stream-index: "002"
        parent_message:
          $ref: '#/components/schemas/MessageResponse'
          description: Parent Message
          title: Message
          x-stream-index: "001.004"
        parent_message_id:
          description: Parent Message ID
          title: Parent Message ID
          type: string
          x-stream-index: "001.003"
        participant_count:
          description: Participant Count
          format: int32
          title: Participant Count
          type: integer
          x-stream-index: "001.008"
        read:
          items:
            $ref: '#/components/schemas/ReadStateResponse'
          type: array
          x-stream-index: "003"
        reply_count:
          description: Reply Count
          format: int32
          title: Reply Count
          type: integer
          x-stream-index: "001.007"
        thread_participants:
          description: Thread Participants
          items:
            $ref: '#/components/schemas/ThreadParticipant'
          title: ThreadParticipants
          type: array
          x-stream-index: "001.010"
        title:
          description: Title
          title: Title
          type: string
          x-stream-index: "001.015"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "001.013"
      required:
      - channel_cid
      - parent_message_id
      - created_by_user_id
      - participant_count
      - active_participant_count
      - created_at
      - updated_at
      - title
      - custom
      - latest_replies
      type: object
    ThreadUpdatedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "001.002"
        channel_type:
          type: string
          x-stream-index: "001.003"
        cid:
          type: string
          x-stream-index: "001.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        thread:
          $ref: '#/components/schemas/ThreadResponse'
          x-stream-index: "003.001"
        type:
          default: thread.updated
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002.001"
      required:
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: ThreadUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    Thresholds:
      description: Sets thresholds for AI moderation
      properties:
        explicit:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for explicit messages
          title: LabelThresholds
          x-stream-index: "001"
        spam:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for spam
          title: LabelThresholds
          x-stream-index: "002"
        toxic:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for toxic messages
          title: LabelThresholds
          x-stream-index: "003"
      title: Auto moderation thresholds
      type: object
    TranslateMessageRequest:
      nullable: true
      properties:
        language:
          description: Language to translate message to
          enum:
          - af
          - sq
          - am
          - ar
          - az
          - bn
          - bs
          - bg
          - zh
          - zh-TW
          - hr
          - cs
          - da
          - fa-AF
          - nl
          - en
          - et
          - fi
          - fr
          - fr-CA
          - ka
          - de
          - el
          - ha
          - he
          - hi
          - hu
          - id
          - it
          - ja
          - ko
          - lv
          - ms
          - "no"
          - fa
          - ps
          - pl
          - pt
          - ro
          - ru
          - sr
          - sk
          - sl
          - so
          - es
          - es-MX
          - sw
          - sv
          - tl
          - ta
          - th
          - tr
          - uk
          - ur
          - vi
          - lt
          - ht
          title: Language
          type: string
          x-stream-index: "001"
      required:
      - language
      type: object
    TruncateChannelRequest:
      nullable: true
      properties:
        hard_delete:
          description: Permanently delete channel data (messages, reactions, etc.)
          title: Hard delete
          type: boolean
          x-stream-index: "002"
        member_ids:
          description: List of member IDs to hide message history for. If empty, truncates
            the channel for all members
          items:
            type: string
          maximum: 100
          title: Member IDs
          type: array
          x-stream-index: "007"
        message:
          $ref: '#/components/schemas/MessageRequest'
          x-stream-index: "004"
        skip_push:
          description: When `message` is set disables all push notifications for it
          title: Skip push
          type: boolean
          x-stream-index: "005"
        truncated_at:
          description: Truncate channel data up to `truncated_at`. The system message
            (if provided) creation time is always greater than `truncated_at`
          format: date-time
          title: Truncated at
          type: string
          x-stream-index: "006"
      type: object
    TruncateChannelResponse:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Truncated channel object
          title: Channel
          x-stream-index: "002"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: Truncated message object
          title: Message
          x-stream-index: "003"
      required:
      - duration
      type: object
    TypingIndicators:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    TypingIndicatorsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    TypingStartEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "003.002"
        channel_type:
          type: string
          x-stream-index: "003.003"
        cid:
          type: string
          x-stream-index: "003.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        parent_id:
          type: string
          x-stream-index: "001"
        type:
          default: typing.start
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002.001"
      required:
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: TypingStartEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    TypingStopEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        parent_id:
          type: string
          x-stream-index: "001"
        type:
          default: typing.stop
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: TypingStopEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UnblockUsersRequest:
      nullable: true
      properties:
        blocked_user_id:
          type: string
          x-stream-index: "001"
      required:
      - blocked_user_id
      type: object
    UnblockUsersResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    UnmuteChannelRequest:
      nullable: true
      properties:
        channel_cids:
          description: Channel CIDs to mute (if multiple channels)
          items:
            type: string
          maximum: 25
          title: Channel CIDs
          type: array
          x-stream-index: "001.002"
        expiration:
          description: Duration of mute in milliseconds
          title: Expiration
          type: integer
          x-stream-index: "001.003"
      type: object
    UnmuteResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        non_existing_users:
          items:
            type: string
          type: array
          x-stream-index: "001"
      required:
      - duration
      title: Response
      type: object
    UnmuteUserRequest:
      nullable: true
      properties:
        target_ids:
          description: User IDs to unmute (if multiple users)
          items:
            type: string
          maximum: 1000
          title: Target IDs
          type: array
          x-stream-index: "002"
      type: object
    UnmuteUserResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        non_existing_users:
          description: List of user IDs that don't exist
          items:
            type: string
          title: Non-existing users
          type: array
          x-stream-index: "001"
      required:
      - 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
    UnreadCountsThread:
      properties:
        last_read:
          format: date-time
          type: string
          x-stream-index: "002"
        last_read_message_id:
          type: string
          x-stream-index: "003"
        parent_message_id:
          type: string
          x-stream-index: "004"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "001"
      required:
      - unread_count
      - last_read
      - last_read_message_id
      - parent_message_id
      type: object
    UpdateBlockListRequest:
      nullable: true
      properties:
        is_leet_check_enabled:
          type: boolean
          x-stream-index: "005"
        is_plural_check_enabled:
          type: boolean
          x-stream-index: "006"
        team:
          type: string
          x-stream-index: "002"
        words:
          description: List of words to block
          items:
            type: string
          minimum: 1
          title: Words
          type: array
          x-stream-index: "003"
      title: Update block list
      type: object
      x-stream-docs-page-id: update_block_list
    UpdateBlockListResponse:
      description: Basic response information
      nullable: true
      properties:
        blocklist:
          $ref: '#/components/schemas/BlockListResponse'
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      title: Response
      type: object
    UpdateChannelPartialRequest:
      nullable: true
      properties:
        set:
          additionalProperties: {}
          type: object
          x-stream-index: "002.001"
        unset:
          items:
            type: string
          type: array
          x-stream-index: "002.002"
      title: UpdateChannelPartialRequest
      type: object
    UpdateChannelPartialResponse:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Updated channel object
          title: Channel
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        members:
          description: List of updated members
          items:
            $ref: '#/components/schemas/ChannelMemberResponse'
          title: ChannelMemberResponse
          type: array
          x-stream-index: "002"
      required:
      - members
      - duration
      type: object
    UpdateChannelRequest:
      nullable: true
      properties:
        accept_invite:
          description: Set to `true` to accept the invite
          title: Accept invite
          type: boolean
          x-stream-index: "008"
        add_filter_tags:
          description: List of filter tags to add to the channel
          items:
            type: string
          title: Add filter tags
          type: array
          x-stream-index: "014"
        add_members:
          description: List of user IDs to add to the channel
          items:
            $ref: '#/components/schemas/ChannelMemberRequest'
          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/ChannelMemberRequest'
          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/ChannelInputRequest'
          x-stream-index: "016.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"
        hide_history_before:
          description: If set, hides channel's history before this time when adding
            new members. Takes precedence over `hide_history` when both are provided.
            Must be in RFC3339 format (e.g., "2024-01-01T10:00:00Z") and in the past.
          format: date-time
          title: Hide history before
          type: string
          x-stream-index: "013"
        invites:
          description: List of user IDs to invite to the channel
          items:
            $ref: '#/components/schemas/ChannelMemberRequest'
          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_filter_tags:
          description: List of filter tags to remove from the channel
          items:
            type: string
          title: Remove filter tags
          type: array
          x-stream-index: "015"
        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/ChannelMemberResponse'
          title: Members
          type: array
          x-stream-index: "003"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: Message sent to the chat
          title: Message
          x-stream-index: "002"
      required:
      - members
      - duration
      type: object
    UpdateLiveLocationRequest:
      nullable: true
      properties:
        end_at:
          description: Time when the live location expires
          format: date-time
          title: string
          type: string
          x-stream-index: "004"
        latitude:
          description: Latitude coordinate
          format: float
          maximum: 90
          minimum: 1.8446744073709552e+19
          title: number
          type: number
          x-stream-index: "002"
        longitude:
          description: Longitude coordinate
          format: float
          maximum: 180
          minimum: 1.8446744073709552e+19
          title: number
          type: number
          x-stream-index: "003"
        message_id:
          description: Live location ID
          title: string
          type: string
          x-stream-index: "001"
      required:
      - message_id
      type: object
    UpdateMemberPartialRequest:
      nullable: true
      properties:
        set:
          additionalProperties: {}
          type: object
          x-stream-index: "002.001"
        unset:
          items:
            type: string
          type: array
          x-stream-index: "002.002"
      type: object
    UpdateMemberPartialResponse:
      nullable: true
      properties:
        channel_member:
          $ref: '#/components/schemas/ChannelMemberResponse'
          description: Updated channel member
          title: Channel member
          x-stream-index: "001"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      type: object
    UpdateMessagePartialRequest:
      nullable: true
      properties:
        set:
          additionalProperties: {}
          description: Sets new field values
          title: Set
          type: object
          x-stream-index: "002.001"
          x-stream-map:
            description: New value to set
            key: field
            title: Value
        skip_enrich_url:
          description: Skip enriching the URL in the message
          title: SkipEnrichURL
          type: boolean
          x-stream-index: "001"
        unset:
          description: Array of field names to unset
          items:
            type: string
          title: Unset
          type: array
          x-stream-index: "002.002"
      type: object
    UpdateMessagePartialResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: Updated message
          title: Message
          x-stream-index: "001"
        pending_message_metadata:
          additionalProperties:
            type: string
          description: Pending message metadata
          title: PendingMessageMetadata
          type: object
          x-stream-index: "002"
      required:
      - duration
      type: object
    UpdateMessageRequest:
      nullable: true
      properties:
        message:
          $ref: '#/components/schemas/MessageRequest'
          description: Message
          title: MessageRequest
          x-stream-index: "001"
        skip_enrich_url:
          description: Skip enrich URL
          title: boolean
          type: boolean
          x-stream-index: "003"
        skip_push:
          type: boolean
          x-stream-index: "002"
      required:
      - message
      type: object
    UpdateMessageResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "001"
        pending_message_metadata:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "002"
      required:
      - message
      - duration
      title: Response
      type: object
    UpdatePollOptionRequest:
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "004"
        id:
          description: Option ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
        text:
          description: Option text
          title: string
          type: string
          x-stream-index: "003"
      required:
      - id
      - text
      type: object
    UpdatePollPartialRequest:
      nullable: true
      properties:
        set:
          additionalProperties: {}
          description: Sets new field values
          title: Set
          type: object
          x-stream-index: "002.001"
          x-stream-map:
            description: New value to set
            key: field
            title: Value
        unset:
          description: Array of field names to unset
          items:
            type: string
          title: Unset
          type: array
          x-stream-index: "002.002"
      type: object
    UpdatePollRequest:
      nullable: true
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "011"
        allow_answers:
          description: Allow answers
          title: boolean
          type: boolean
          x-stream-index: "009"
        allow_user_suggested_options:
          description: Allow user suggested options
          title: boolean
          type: boolean
          x-stream-index: "008"
        description:
          description: Poll description
          title: string
          type: string
          x-stream-index: "003"
        enforce_unique_vote:
          description: Enforce unique vote
          title: boolean
          type: boolean
          x-stream-index: "005"
        id:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
        is_closed:
          description: Is closed
          title: boolean
          type: boolean
          x-stream-index: "010"
        max_votes_allowed:
          description: Max votes allowed
          format: int32
          maximum: 10
          title: integer
          type: integer
          x-stream-index: "007"
        name:
          description: Poll name
          title: string
          type: string
          x-stream-index: "002"
        options:
          description: Poll options
          items:
            $ref: '#/components/schemas/PollOptionRequest'
          maximum: 100
          title: PollOptions
          type: array
          x-stream-index: "004"
        voting_visibility:
          description: Voting visibility
          enum:
          - anonymous
          - public
          title: string
          type: string
          x-stream-index: "006"
      required:
      - id
      - name
      type: object
    UpdateReminderRequest:
      nullable: true
      properties:
        remind_at:
          format: date-time
          type: string
          x-stream-index: "001"
      type: object
    UpdateReminderResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "001"
      required:
      - reminder
      - duration
      title: Response
      type: object
    UpdateThreadPartialRequest:
      nullable: true
      properties:
        set:
          additionalProperties: {}
          description: Sets new field values
          title: Set
          type: object
          x-stream-index: "004.001"
          x-stream-map:
            description: New value to set
            key: field
            title: Value
        unset:
          description: Array of field names to unset
          items:
            type: string
          title: Unset
          type: array
          x-stream-index: "004.002"
      type: object
    UpdateThreadPartialResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        thread:
          $ref: '#/components/schemas/ThreadResponse'
          description: Updated thread (not enriched)
          title: Thread
          x-stream-index: "001"
      required:
      - thread
      - duration
      type: object
    UpdateUserPartialRequest:
      properties:
        id:
          description: User ID to update
          title: ID
          type: string
          x-stream-index: "001"
        set:
          additionalProperties: {}
          type: object
          x-stream-index: "002.001"
        unset:
          items:
            type: string
          type: array
          x-stream-index: "002.002"
      required:
      - id
      type: object
    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
    UploadChannelFileRequest:
      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
    UploadChannelFileResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "004.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"
        moderation_action:
          type: string
          x-stream-index: "003"
        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
    UploadChannelRequest:
      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
    UploadChannelResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: 001.004.001
        file:
          type: string
          x-stream-index: "001.001"
        moderation_action:
          type: string
          x-stream-index: "001.003"
        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
    UpsertPushPreferencesRequest:
      nullable: true
      properties:
        preferences:
          description: A list of push preferences for channels, calls, or the user.
          items:
            $ref: '#/components/schemas/PushPreferenceInput'
          type: array
          x-stream-index: "001"
      required:
      - preferences
      type: object
    UpsertPushPreferencesResponse:
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        user_channel_preferences:
          additionalProperties:
            additionalProperties:
              $ref: '#/components/schemas/ChannelPushPreferences'
            type: object
          description: The channel specific push notification preferences, only returned
            for channels you've edited.
          title: User Channel Notification Preferences
          type: object
          x-stream-index: "002"
        user_preferences:
          additionalProperties:
            $ref: '#/components/schemas/PushPreferences'
          description: The user preferences, always returned regardless if you edited
            it
          title: User Preferences
          type: object
          x-stream-index: "001"
      required:
      - user_preferences
      - user_channel_preferences
      - duration
      type: object
    User:
      properties:
        ban_expires:
          format: date-time
          type: string
          x-stream-index: "017"
        banned:
          type: boolean
          x-stream-index: "016"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        id:
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "023"
        language:
          type: string
          x-stream-index: "035"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettings'
          x-stream-index: "026"
        revoke_tokens_issued_before:
          format: date-time
          type: string
          x-stream-index: "043"
        role:
          type: string
          x-stream-index: "004"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "036"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "005"
      required:
      - id
      type: object
    UserBannedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "006.002"
        channel_type:
          type: string
          x-stream-index: "006.003"
        cid:
          type: string
          x-stream-index: "006.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "008.002"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "001"
        expiration:
          format: date-time
          type: string
          x-stream-index: "003"
        reason:
          type: string
          x-stream-index: "004"
        shadow:
          type: boolean
          x-stream-index: "002"
        team:
          type: string
          x-stream-index: "005.001"
        type:
          default: user.banned
          type: string
          x-stream-index: "008.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "007.001"
      required:
      - created_by
      - shadow
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: UserBannedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserDeactivatedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.002"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "001"
        type:
          default: user.deactivated
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002.001"
      required:
      - created_by
      - type
      - created_at
      title: UserDeactivatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserDeletedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        delete_conversation_channels:
          type: boolean
          x-stream-index: "005"
        hard_delete:
          type: boolean
          x-stream-index: "003.001"
        mark_messages_deleted:
          type: boolean
          x-stream-index: "004"
        type:
          default: user.deleted
          type: string
          x-stream-index: "002.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      - hard_delete
      - mark_messages_deleted
      - delete_conversation_channels
      title: UserDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserMessagesDeletedEvent:
      description: This event is sent when a user's message get deleted. The event
        contains information about the user whose messages got deleted.
      nullable: true
      properties:
        channel_custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.006
        channel_id:
          description: The ID of the channel where the target user's messages were
            deleted
          title: Channel ID
          type: string
          x-stream-index: 001.002.002
        channel_member_count:
          format: int32
          type: integer
          x-stream-index: 001.001.004
        channel_message_count:
          format: int64
          type: integer
          x-stream-index: 001.001.005
        channel_type:
          description: The type of the channel where the target user's messages were
            deleted
          title: Channel Type
          type: string
          x-stream-index: 001.002.001
        cid:
          description: The CID of the channel where the target user's messages were
            deleted
          title: Channel CID
          type: string
          x-stream-index: 001.001.001.002
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: 001.001.001.001.003
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.001.001.007
        hard_delete:
          description: Whether Messages were hard deleted
          title: Hard Delete
          type: boolean
          x-stream-index: "003"
        received_at:
          format: date-time
          type: string
          x-stream-index: 001.001.001.001.004
        team:
          description: The team of the channel where the target user's messages were
            deleted
          title: Team
          type: string
          x-stream-index: 001.001.003
        type:
          default: user.messages.deleted
          description: 'The type of event: "user.messages.deleted" in this case'
          title: Event Type
          type: string
          x-stream-index: 001.001.001.001.002
        user:
          $ref: '#/components/schemas/UserResponseCommonFields'
          description: The target user whose messages got deleted
          title: User
          x-stream-index: "002.001"
      required:
      - type
      - created_at
      - custom
      - user
      title: UserMessagesDeletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserMute:
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "009"
        expires:
          description: Date/time of mute expiration
          format: date-time
          title: Expires
          type: string
          x-stream-index: "008"
        target:
          $ref: '#/components/schemas/User'
          description: User who's muted
          title: Target
          x-stream-index: "007"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "010"
        user:
          $ref: '#/components/schemas/User'
          description: Owner of channel mute
          title: User
          x-stream-index: "005"
      required:
      - created_at
      - updated_at
      type: object
    UserMuteResponse:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "004"
        expires:
          format: date-time
          type: string
          x-stream-index: "003"
        target:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
      required:
      - created_at
      - updated_at
      type: object
    UserMutedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "004.002"
        target_user:
          type: string
          x-stream-index: "001"
        target_users:
          items:
            type: string
          type: array
          x-stream-index: "002"
        type:
          default: user.muted
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      title: UserMutedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserPresenceChangedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        type:
          default: user.presence.changed
          type: string
          x-stream-index: "002.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "001.001"
      required:
      - type
      - created_at
      title: UserPresenceChangedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserReactivatedEvent:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        type:
          default: user.reactivated
          type: string
          x-stream-index: "002.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "001"
      required:
      - type
      - created_at
      title: UserReactivatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserRequest:
      description: User request object
      properties:
        custom:
          additionalProperties: {}
          description: Custom user data
          title: Custom
          type: object
          x-stream-index: "004"
        id:
          description: User ID
          title: ID
          type: string
          x-stream-index: "001"
        image:
          description: User's profile image URL
          title: Image
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "006"
        language:
          type: string
          x-stream-index: "005"
        name:
          description: Optional name of user
          title: Name
          type: string
          x-stream-index: "002"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "007"
      required:
      - id
      title: UserRequest
      type: object
    UserResponse:
      description: User response object
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        banned:
          description: Whether a user is banned or not
          title: Banned
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "001.017"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          description: Date of deactivation
          format: date-time
          title: Deactivated at
          type: string
          x-stream-index: "001.016"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: string
          x-stream-index: "001.011"
        id:
          description: Unique user identifier
          title: ID
          type: string
          x-stream-index: "001.001"
        image:
          title: Image
          type: string
          x-stream-index: "001.003"
        language:
          description: Preferred language of a user
          title: Language
          type: string
          x-stream-index: "001.005"
        last_active:
          description: Date of last activity
          format: date-time
          title: Last active
          type: string
          x-stream-index: "001.014"
        name:
          description: Optional name of user
          title: Name
          type: string
          x-stream-index: "001.002"
        online:
          description: Whether a user online or not
          title: Online
          type: boolean
          x-stream-index: "001.013"
        revoke_tokens_issued_before:
          description: Revocation date for tokens
          format: date-time
          title: Revoke tokens issued before
          type: string
          x-stream-index: "001.015"
        role:
          description: Determines the set of user permissions
          title: Role
          type: string
          x-stream-index: "001.006"
        teams:
          description: List of teams user is a part of
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      - shadow_banned
      - invisible
      title: UserResponse
      type: object
    UserResponseCommonFields:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "018"
        banned:
          type: boolean
          x-stream-index: "012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "017"
        created_at:
          format: date-time
          type: string
          x-stream-index: "009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        deactivated_at:
          format: date-time
          type: string
          x-stream-index: "016"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "011"
        id:
          type: string
          x-stream-index: "001"
        image:
          type: string
          x-stream-index: "003"
        language:
          type: string
          x-stream-index: "005"
        last_active:
          format: date-time
          type: string
          x-stream-index: "014"
        name:
          type: string
          x-stream-index: "002"
        online:
          type: boolean
          x-stream-index: "013"
        revoke_tokens_issued_before:
          format: date-time
          type: string
          x-stream-index: "015"
        role:
          type: string
          x-stream-index: "006"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "008"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      type: object
    UserResponsePrivacyFields:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        banned:
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "001.017"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          format: date-time
          type: string
          x-stream-index: "001.016"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "001.011"
        id:
          type: string
          x-stream-index: "001.001"
        image:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "003"
        language:
          type: string
          x-stream-index: "001.005"
        last_active:
          format: date-time
          type: string
          x-stream-index: "001.014"
        name:
          type: string
          x-stream-index: "001.002"
        online:
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "002"
        revoke_tokens_issued_before:
          format: date-time
          type: string
          x-stream-index: "001.015"
        role:
          type: string
          x-stream-index: "001.006"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      type: object
    UserUnbannedEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "002.002"
        channel_type:
          type: string
          x-stream-index: "002.003"
        cid:
          type: string
          x-stream-index: "002.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "005.002"
        shadow:
          type: boolean
          x-stream-index: "001"
        team:
          type: string
          x-stream-index: "004.001"
        type:
          default: user.unbanned
          type: string
          x-stream-index: "005.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - shadow
      - cid
      - channel_id
      - channel_type
      - type
      - created_at
      title: UserUnbannedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserUpdatedEvent:
      description: This event is sent when a user gets updated. The event contains
        information about the updated user.
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        type:
          default: user.updated
          description: 'The type of event: "user.updated" in this case'
          title: Event Type
          type: string
          x-stream-index: "001.002"
        user:
          $ref: '#/components/schemas/UserResponsePrivacyFields'
          description: The updated user
          title: User
          x-stream-index: "002.001"
      required:
      - type
      - created_at
      - custom
      - user
      title: UserUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserWatchingStartEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.002"
        team:
          type: string
          x-stream-index: "002.001"
        type:
          default: user.watching.start
          type: string
          x-stream-index: "003.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005.001"
        watcher_count:
          format: int32
          type: integer
          x-stream-index: "001.001"
      required:
      - watcher_count
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: UserWatchingStartEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    UserWatchingStopEvent:
      properties:
        channel_id:
          type: string
          x-stream-index: "004.002"
        channel_type:
          type: string
          x-stream-index: "004.003"
        cid:
          type: string
          x-stream-index: "004.001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        type:
          default: user.watching.stop
          type: string
          x-stream-index: "002.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
        watcher_count:
          format: int32
          type: integer
          x-stream-index: "001.001"
      required:
      - watcher_count
      - type
      - created_at
      - cid
      - channel_id
      - channel_type
      title: UserWatchingStopEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    VoteData:
      properties:
        answer_text:
          type: string
          x-stream-index: "002"
        option_id:
          maxLength: 255
          type: string
          x-stream-index: "001"
      type: object
    WSClientEvent:
      description: The discriminator object for all websocket client events, it maps
        events' payload to the final type
      discriminator:
        mapping:
          app.updated: '#/components/schemas/AppUpdatedEvent'
          draft.deleted: '#/components/schemas/DraftDeletedEvent'
          draft.updated: '#/components/schemas/DraftUpdatedEvent'
          health.check: '#/components/schemas/HealthCheckEvent'
          message.delivered: '#/components/schemas/MessageDeliveredEvent'
          message.pending: '#/components/schemas/PendingMessageEvent'
          notification.reminder_due: '#/components/schemas/ReminderNotificationEvent'
          poll.closed: '#/components/schemas/PollClosedEvent'
          poll.deleted: '#/components/schemas/PollDeletedEvent'
          poll.updated: '#/components/schemas/PollUpdatedEvent'
          poll.vote_casted: '#/components/schemas/PollVoteCastedEvent'
          poll.vote_changed: '#/components/schemas/PollVoteChangedEvent'
          poll.vote_removed: '#/components/schemas/PollVoteRemovedEvent'
          reminder.created: '#/components/schemas/ReminderCreatedEvent'
          reminder.deleted: '#/components/schemas/ReminderDeletedEvent'
          reminder.updated: '#/components/schemas/ReminderUpdatedEvent'
          user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent'
          user.updated: '#/components/schemas/UserUpdatedEvent'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/AppUpdatedEvent'
      - $ref: '#/components/schemas/DraftDeletedEvent'
      - $ref: '#/components/schemas/DraftUpdatedEvent'
      - $ref: '#/components/schemas/HealthCheckEvent'
      - $ref: '#/components/schemas/MessageDeliveredEvent'
      - $ref: '#/components/schemas/PendingMessageEvent'
      - $ref: '#/components/schemas/PollClosedEvent'
      - $ref: '#/components/schemas/PollDeletedEvent'
      - $ref: '#/components/schemas/PollUpdatedEvent'
      - $ref: '#/components/schemas/PollVoteCastedEvent'
      - $ref: '#/components/schemas/PollVoteChangedEvent'
      - $ref: '#/components/schemas/PollVoteRemovedEvent'
      - $ref: '#/components/schemas/ReminderCreatedEvent'
      - $ref: '#/components/schemas/ReminderDeletedEvent'
      - $ref: '#/components/schemas/ReminderNotificationEvent'
      - $ref: '#/components/schemas/ReminderUpdatedEvent'
      - $ref: '#/components/schemas/UserMessagesDeletedEvent'
      - $ref: '#/components/schemas/UserUpdatedEvent'
    WSEvent:
      description: The discriminator object for all websocket events, it maps events'
        payload to the final type
      discriminator:
        mapping:
          '*': '#/components/schemas/AnyEvent'
          activity.marked: '#/components/schemas/ActivityMarkedEvent'
          ai_indicator.clear: '#/components/schemas/AIIndicatorClearEvent'
          ai_indicator.stop: '#/components/schemas/AIIndicatorStopEvent'
          ai_indicator.update: '#/components/schemas/AIIndicatorUpdateEvent'
          app.updated: '#/components/schemas/AppUpdatedEvent'
          channel.created: '#/components/schemas/ChannelCreatedEvent'
          channel.deleted: '#/components/schemas/ChannelDeletedEvent'
          channel.frozen: '#/components/schemas/ChannelFrozenEvent'
          channel.hidden: '#/components/schemas/ChannelHiddenEvent'
          channel.kicked: '#/components/schemas/ChannelKickedEvent'
          channel.truncated: '#/components/schemas/ChannelTruncatedEvent'
          channel.unfrozen: '#/components/schemas/ChannelUnFrozenEvent'
          channel.updated: '#/components/schemas/ChannelUpdatedEvent'
          channel.visible: '#/components/schemas/ChannelVisibleEvent'
          draft.deleted: '#/components/schemas/DraftDeletedEvent'
          draft.updated: '#/components/schemas/DraftUpdatedEvent'
          health.check: '#/components/schemas/HealthCheckEvent'
          member.added: '#/components/schemas/MemberAddedEvent'
          member.removed: '#/components/schemas/MemberRemovedEvent'
          member.updated: '#/components/schemas/MemberUpdatedEvent'
          message.deleted: '#/components/schemas/MessageDeletedEvent'
          message.delivered: '#/components/schemas/MessageDeliveredEvent'
          message.new: '#/components/schemas/MessageNewEvent'
          message.pending: '#/components/schemas/PendingMessageEvent'
          message.read: '#/components/schemas/MessageReadEvent'
          message.undeleted: '#/components/schemas/MessageUndeletedEvent'
          message.updated: '#/components/schemas/MessageUpdatedEvent'
          notification.added_to_channel: '#/components/schemas/NotificationAddedToChannelEvent'
          notification.channel_deleted: '#/components/schemas/NotificationChannelDeletedEvent'
          notification.channel_mutes_updated: '#/components/schemas/NotificationChannelMutesUpdatedEvent'
          notification.channel_truncated: '#/components/schemas/NotificationChannelTruncatedEvent'
          notification.invite_accepted: '#/components/schemas/NotificationInviteAcceptedEvent'
          notification.invite_rejected: '#/components/schemas/NotificationInviteRejectedEvent'
          notification.invited: '#/components/schemas/NotificationInvitedEvent'
          notification.mark_read: '#/components/schemas/NotificationMarkReadEvent'
          notification.mark_unread: '#/components/schemas/NotificationMarkUnreadEvent'
          notification.message_new: '#/components/schemas/NotificationNewMessageEvent'
          notification.mutes_updated: '#/components/schemas/NotificationMutesUpdatedEvent'
          notification.reminder_due: '#/components/schemas/ReminderNotificationEvent'
          notification.removed_from_channel: '#/components/schemas/NotificationRemovedFromChannelEvent'
          notification.thread_message_new: '#/components/schemas/MessageNewEvent'
          poll.closed: '#/components/schemas/PollClosedEvent'
          poll.deleted: '#/components/schemas/PollDeletedEvent'
          poll.updated: '#/components/schemas/PollUpdatedEvent'
          poll.vote_casted: '#/components/schemas/PollVoteCastedEvent'
          poll.vote_changed: '#/components/schemas/PollVoteChangedEvent'
          poll.vote_removed: '#/components/schemas/PollVoteRemovedEvent'
          reaction.deleted: '#/components/schemas/ReactionDeletedEvent'
          reaction.new: '#/components/schemas/ReactionNewEvent'
          reaction.updated: '#/components/schemas/ReactionUpdatedEvent'
          reminder.created: '#/components/schemas/ReminderCreatedEvent'
          reminder.deleted: '#/components/schemas/ReminderDeletedEvent'
          reminder.updated: '#/components/schemas/ReminderUpdatedEvent'
          thread.updated: '#/components/schemas/ThreadUpdatedEvent'
          typing.start: '#/components/schemas/TypingStartEvent'
          typing.stop: '#/components/schemas/TypingStopEvent'
          user.banned: '#/components/schemas/UserBannedEvent'
          user.deactivated: '#/components/schemas/UserDeactivatedEvent'
          user.deleted: '#/components/schemas/UserDeletedEvent'
          user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent'
          user.muted: '#/components/schemas/UserMutedEvent'
          user.presence.changed: '#/components/schemas/UserPresenceChangedEvent'
          user.reactivated: '#/components/schemas/UserReactivatedEvent'
          user.unbanned: '#/components/schemas/UserUnbannedEvent'
          user.updated: '#/components/schemas/UserUpdatedEvent'
          user.watching.start: '#/components/schemas/UserWatchingStartEvent'
          user.watching.stop: '#/components/schemas/UserWatchingStopEvent'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/AIIndicatorClearEvent'
      - $ref: '#/components/schemas/AIIndicatorStopEvent'
      - $ref: '#/components/schemas/AIIndicatorUpdateEvent'
      - $ref: '#/components/schemas/ActivityMarkedEvent'
      - $ref: '#/components/schemas/AnyEvent'
      - $ref: '#/components/schemas/AppUpdatedEvent'
      - $ref: '#/components/schemas/ChannelCreatedEvent'
      - $ref: '#/components/schemas/ChannelDeletedEvent'
      - $ref: '#/components/schemas/ChannelFrozenEvent'
      - $ref: '#/components/schemas/ChannelHiddenEvent'
      - $ref: '#/components/schemas/ChannelKickedEvent'
      - $ref: '#/components/schemas/ChannelTruncatedEvent'
      - $ref: '#/components/schemas/ChannelUnFrozenEvent'
      - $ref: '#/components/schemas/ChannelUpdatedEvent'
      - $ref: '#/components/schemas/ChannelVisibleEvent'
      - $ref: '#/components/schemas/DraftDeletedEvent'
      - $ref: '#/components/schemas/DraftUpdatedEvent'
      - $ref: '#/components/schemas/HealthCheckEvent'
      - $ref: '#/components/schemas/MemberAddedEvent'
      - $ref: '#/components/schemas/MemberRemovedEvent'
      - $ref: '#/components/schemas/MemberUpdatedEvent'
      - $ref: '#/components/schemas/MessageDeletedEvent'
      - $ref: '#/components/schemas/MessageDeliveredEvent'
      - $ref: '#/components/schemas/MessageNewEvent'
      - $ref: '#/components/schemas/MessageNewEvent'
      - $ref: '#/components/schemas/MessageReadEvent'
      - $ref: '#/components/schemas/MessageUndeletedEvent'
      - $ref: '#/components/schemas/MessageUpdatedEvent'
      - $ref: '#/components/schemas/NotificationAddedToChannelEvent'
      - $ref: '#/components/schemas/NotificationChannelDeletedEvent'
      - $ref: '#/components/schemas/NotificationChannelMutesUpdatedEvent'
      - $ref: '#/components/schemas/NotificationChannelTruncatedEvent'
      - $ref: '#/components/schemas/NotificationInviteAcceptedEvent'
      - $ref: '#/components/schemas/NotificationInviteRejectedEvent'
      - $ref: '#/components/schemas/NotificationInvitedEvent'
      - $ref: '#/components/schemas/NotificationMarkReadEvent'
      - $ref: '#/components/schemas/NotificationMarkUnreadEvent'
      - $ref: '#/components/schemas/NotificationMutesUpdatedEvent'
      - $ref: '#/components/schemas/NotificationNewMessageEvent'
      - $ref: '#/components/schemas/NotificationRemovedFromChannelEvent'
      - $ref: '#/components/schemas/PendingMessageEvent'
      - $ref: '#/components/schemas/PollClosedEvent'
      - $ref: '#/components/schemas/PollDeletedEvent'
      - $ref: '#/components/schemas/PollUpdatedEvent'
      - $ref: '#/components/schemas/PollVoteCastedEvent'
      - $ref: '#/components/schemas/PollVoteChangedEvent'
      - $ref: '#/components/schemas/PollVoteRemovedEvent'
      - $ref: '#/components/schemas/ReactionDeletedEvent'
      - $ref: '#/components/schemas/ReactionNewEvent'
      - $ref: '#/components/schemas/ReactionUpdatedEvent'
      - $ref: '#/components/schemas/ReminderCreatedEvent'
      - $ref: '#/components/schemas/ReminderDeletedEvent'
      - $ref: '#/components/schemas/ReminderNotificationEvent'
      - $ref: '#/components/schemas/ReminderUpdatedEvent'
      - $ref: '#/components/schemas/ThreadUpdatedEvent'
      - $ref: '#/components/schemas/TypingStartEvent'
      - $ref: '#/components/schemas/TypingStopEvent'
      - $ref: '#/components/schemas/UserBannedEvent'
      - $ref: '#/components/schemas/UserDeactivatedEvent'
      - $ref: '#/components/schemas/UserDeletedEvent'
      - $ref: '#/components/schemas/UserMessagesDeletedEvent'
      - $ref: '#/components/schemas/UserMutedEvent'
      - $ref: '#/components/schemas/UserPresenceChangedEvent'
      - $ref: '#/components/schemas/UserReactivatedEvent'
      - $ref: '#/components/schemas/UserUnbannedEvent'
      - $ref: '#/components/schemas/UserUpdatedEvent'
      - $ref: '#/components/schemas/UserWatchingStartEvent'
      - $ref: '#/components/schemas/UserWatchingStopEvent'
    WrappedUnreadCountsResponse:
      description: Basic response information
      nullable: true
      properties:
        channel_type:
          items:
            $ref: '#/components/schemas/UnreadCountsChannelType'
          type: array
          x-stream-index: "001.005"
        channels:
          items:
            $ref: '#/components/schemas/UnreadCountsChannel'
          type: array
          x-stream-index: "001.004"
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "002.001"
        threads:
          items:
            $ref: '#/components/schemas/UnreadCountsThread'
          type: array
          x-stream-index: "001.006"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "001.001"
        total_unread_count_by_team:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "001.003"
        total_unread_threads_count:
          format: int32
          type: integer
          x-stream-index: "001.002"
      required:
      - total_unread_count
      - total_unread_threads_count
      - channels
      - channel_type
      - threads
      - duration
      title: Response
      type: object
    connectRequestQuery:
      nullable: true
      type: object
  securitySchemes:
    JWT:
      description: |
        JWT should be always provided when stream-auth-type=jwt.

        Using JWT auth request could be authenticated as user or as server-side.

        When using user authentication permission checking is going to be applied to requests based on the user that is
        performing a request.

        The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform
        requests.

        **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not
        shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.
        If you wish, you can configure your application to ignore authentication (see `disable_auth_check`)
        The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.
      in: header
      name: Authorization
      type: apiKey
    api_key:
      description: Application API key should be always set in order to authenticate
        the request.
      in: query
      name: api_key
      type: apiKey
    stream-auth-type:
      description: |-
        Stream-Auth-Type should be always set in order to authenticate the request. Possible
        values: `jwt` or `anonymous`.

        `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization
        header.

        `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available
        to anonymous users.
      in: header
      name: Stream-Auth-Type
      type: apiKey
info:
  title: Stream API
  version: v214.3.0
openapi: 3.0.3
paths:
  /app:
    get:
      description: |
        This Method returns the application settings
      operationId: GetApp
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get App Settings
      tags:
      - product:chat
  /blocklists:
    get:
      description: |
        Returns all available block lists
      operationId: ListBlockLists
      parameters:
      - in: query
        name: team
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBlockListResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List block lists
      tags:
      - product:chat
    post:
      description: |
        Creates a new application blocklist, once created the blocklist can be used by any channel type
      operationId: CreateBlockList
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBlockListRequest'
        description: Block list
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBlockListResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create block list
      tags:
      - product:chat
  /blocklists/{name}:
    delete:
      description: |
        Deletes previously created application blocklist
      operationId: DeleteBlockList
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: team
        schema:
          type: string
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete block list
      tags:
      - product:chat
    put:
      description: |
        Updates contents of the block list
      operationId: UpdateBlockList
      parameters:
      - in: path
        name: name
        required: true
        schema:
          description: Block list name
          title: Name
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBlockListRequest'
        description: Update block list
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBlockListResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update block list
      tags:
      - product:chat
  /channels:
    post:
      description: |
        Query channels with filter query
      operationId: QueryChannels
      parameters:
      - in: query
        name: connection_id
        schema:
          description: Websocket connection ID to interact with. You can pass it as
            Body or URL parameter
          title: Connection ID
          type: string
          x-stream-index: "011.003"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryChannelsRequest'
        description: Query Channels Request
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryChannelsResponse'
          description: Channels list
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query channels
      tags:
      - product:chat
  /channels/{type}/{id}:
    delete:
      description: |
        Deletes channel

        Sends events:
        - channel.deleted
        - channel.deleted
      operationId: DeleteChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type to interact with
          title: Channel type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Channel ID to interact with
          title: Channel ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      - in: query
        name: hard_delete
        schema:
          type: boolean
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteChannelResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete channel
      tags:
      - product:chat
    patch:
      description: |
        Updates certain fields of the channel

        Sends events:
        - channel.updated
        - channel.updated
      operationId: UpdateChannelPartial
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type to interact with
          title: Channel type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Channel ID to interact with
          title: Channel ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChannelPartialRequest'
        description: UpdateChannelPartialRequest
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChannelPartialResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Partially update channel
      tags:
      - product:chat
    post:
      description: |
        Change channel data

        Sends events:
        - channel.updated
        - member.added
        - member.removed
        - member.updated
        - message.new
        - channel.updated
        - message.new
      operationId: UpdateChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: 016.002.001
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: 016.002.002
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChannelRequest'
        description: Channel update request
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChannelResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update channel
      tags:
      - product:chat
  /channels/{type}/{id}/draft:
    delete:
      description: |
        Deletes a draft

        Sends events:
        - draft.deleted
      operationId: DeleteDraft
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      - in: query
        name: parent_id
        schema:
          description: Parent message ID
          title: string
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete draft
      tags:
      - product:chat
    get:
      description: |
        Get a draft
      operationId: GetDraft
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      - in: query
        name: parent_id
        schema:
          description: Parent message ID
          title: string
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDraftResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get draft
      tags:
      - product:chat
    post:
      description: |
        Creates a draft

        Sends events:
        - draft.updated
      operationId: CreateDraft
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type to interact with
          title: Channel type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Channel ID to interact with
          title: Channel ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDraftRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDraftResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create a draft
      tags:
      - product:chat
  /channels/{type}/{id}/event:
    post:
      description: |
        Sends event to the channel
      operationId: SendEvent
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type to interact with
          title: Channel type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: Channel ID to interact with
          title: Channel ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendEventRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Send event
      tags:
      - product:chat
  /channels/{type}/{id}/file:
    delete:
      description: |
        Deletes previously uploaded file
      operationId: DeleteChannelFile
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of file
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: File ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      - in: query
        name: url
        schema:
          description: File URL to delete
          title: URL
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete file
      tags:
      - product:chat
    post:
      description: |
        Uploads file
      operationId: UploadChannelFile
      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/UploadChannelFileRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadChannelFileResponse'
          description: Successful response
        "400":
          content:
            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

        Sends events:
        - channel.hidden
        - channel.hidden
      operationId: HideChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HideChannelRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HideChannelResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Hide channel
      tags:
      - product:chat
  /channels/{type}/{id}/image:
    delete:
      description: |
        Deletes previously uploaded image
      operationId: DeleteChannelImage
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: The type of file
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          description: File ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      - in: query
        name: url
        schema:
          description: File URL to delete
          title: URL
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete image
      tags:
      - product:chat
    post:
      description: |
        Uploads image
      operationId: UploadChannelImage
      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/UploadChannelRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadChannelResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Upload image
      tags:
      - product:chat
  /channels/{type}/{id}/member:
    patch:
      description: |2+

      operationId: UpdateMemberPartial
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "003.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "003.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMemberPartialRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMemberPartialResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Partially channel member update
      tags:
      - product:chat
  /channels/{type}/{id}/message:
    post:
      description: |
        Sends new message to the specified channel

        Sends events:
        - message.new
        - message.updated
        - message.new
        - message.updated
      operationId: SendMessage
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type to interact with
          title: Channel type
          type: string
          writeOnly: true
          x-stream-index: "009.001"
      - in: path
        name: id
        required: true
        schema:
          description: Channel ID to interact with
          title: Channel ID
          type: string
          writeOnly: true
          x-stream-index: "009.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendMessageRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendMessageResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Send new message
      tags:
      - product:chat
  /channels/{type}/{id}/messages:
    get:
      description: |
        Returns list messages found by IDs
      operationId: GetManyMessages
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      - in: query
        name: ids
        required: true
        schema:
          description: List of comma-separated IDs
          items:
            type: string
          maximum: 50
          minimum: 1
          title: IDs
          type: array
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetManyMessagesResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get many messages
      tags:
      - product:chat
  /channels/{type}/{id}/query:
    post:
      description: |
        This Method creates a channel or returns an existing one with matching attributes

        Sends events:
        - channel.created
        - member.added
        - member.removed
        - member.updated
        - user.watching.start
        - channel.created
        - user.watching.start
      operationId: GetOrCreateChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: path
        name: id
        required: true
        schema:
          description: Channel ID (maximum length of 64 characters)
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: connection_id
        schema:
          description: Websocket connection ID to interact with. You can pass it as
            Body or URL parameter
          title: Connection ID
          type: string
          x-stream-index: "012.003"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelGetOrCreateRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelStateResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get or create channel
      tags:
      - product:chat
  /channels/{type}/{id}/read:
    post:
      description: |
        Marks channel as read up to the specific message

        Sends events:
        - message.read
        - message.read
      operationId: MarkRead
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "003.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "003.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkReadRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkReadResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Mark read
      tags:
      - product:chat
  /channels/{type}/{id}/show:
    post:
      description: |
        Shows previously hidden channel

        Sends events:
        - channel.visible
        - channel.visible
      operationId: ShowChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type to interact with
          title: Channel type
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          description: Channel ID to interact with
          title: Channel ID
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShowChannelRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShowChannelResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Show channel
      tags:
      - product:chat
  /channels/{type}/{id}/stop-watching:
    post:
      description: |
        Call this Method to stop receiving channel events

        Sends events:
        - user.watching.stop
        - user.watching.stop
      operationId: StopWatchingChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      - in: query
        name: connection_id
        schema:
          type: string
          x-stream-index: "001.003"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelStopWatchingRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Stop watching channel
      tags:
      - product:chat
  /channels/{type}/{id}/truncate:
    post:
      description: |
        Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.

        Sends events:
        - channel.truncated
        - channel.truncated
      operationId: TruncateChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TruncateChannelRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TruncateChannelResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Truncate channel
      tags:
      - product:chat
  /channels/{type}/{id}/unread:
    post:
      description: |
        Marks channel as unread from a specific message
      operationId: MarkUnread
      parameters:
      - in: path
        name: type
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002.002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkUnreadRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Mark unread
      tags:
      - product:chat
  /channels/{type}/query:
    post:
      description: |
        This Method creates a channel or returns an existing one with matching attributes

        Sends events:
        - channel.created
        - member.added
        - member.removed
        - member.updated
        - user.watching.start
        - channel.created
        - user.watching.start
      operationId: GetOrCreateDistinctChannel
      parameters:
      - in: path
        name: type
        required: true
        schema:
          description: Channel type
          maxLength: 64
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: connection_id
        schema:
          description: Websocket connection ID to interact with. You can pass it as
            Body or URL parameter
          title: Connection ID
          type: string
          x-stream-index: "012.003"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelGetOrCreateRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelStateResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get or create channel
      tags:
      - product:chat
  /channels/delete:
    post:
      description: |
        Allows to delete several channels at once asynchronously

        Sends events:
        - channel.deleted
        - channel.deleted
      operationId: DeleteChannels
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteChannelsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteChannelsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Deletes channels asynchronously
      tags:
      - product:chat
  /channels/delivered:
    post:
      description: |
        Mark the status of a channel message delivered.
      operationId: MarkDelivered
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkDeliveredRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkDeliveredResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Mark channel message delivery status
      tags:
      - product:chat
  /channels/read:
    post:
      description: |
        Marks channels as read up to the specific message. If no channels is given, mark all channel as read

        Sends events:
        - message.read
        - message.read
      operationId: MarkChannelsRead
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkChannelsReadRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkReadResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Mark channels as read
      tags:
      - product:chat
  /devices:
    delete:
      description: |
        Deletes one device
      operationId: DeleteDevice
      parameters:
      - in: query
        name: id
        required: true
        schema:
          description: Device ID to delete
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete device
      tags:
      - product:chat
    get:
      description: |
        Returns all available devices
      operationId: ListDevices
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevicesResponse'
          description: ListDevicesResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List devices
      tags:
      - product:chat
    post:
      description: |
        Adds a new device to a user, if the same device already exists the call will have no effect
      operationId: CreateDevice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeviceRequest'
        description: CreateDeviceRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create device
      tags:
      - product:chat
  /drafts/query:
    post:
      description: |
        Queries draft messages for a user
      operationId: QueryDrafts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryDraftsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryDraftsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query draft messages
      tags:
      - product:chat
  /guest:
    post:
      description: |2+

      operationId: CreateGuest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGuestRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGuestResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create Guest
      tags:
      - product:chat
  /longpoll:
    get:
      description: |
        WebSocket fallback transport endpoint

        Sends events:
        - user.updated
      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
      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

        Sends events:
        - message.deleted
        - message.deleted
      operationId: DeleteMessage
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Message ID to delete
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: hard
        schema:
          description: Delete all message reactions and replies as well
          title: Hard
          type: boolean
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: deleted_by
        schema:
          type: string
          writeOnly: true
          x-stream-index: "003"
      - in: query
        name: delete_for_me
        schema:
          description: Delete the message only for the user making the request
          title: Delete for me
          type: boolean
          writeOnly: true
          x-stream-index: "004"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteMessageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete message
      tags:
      - product:chat
    get:
      description: |
        Returns message by ID
      operationId: GetMessage
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: ID of the message
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMessageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get message
      tags:
      - product:chat
    post:
      description: |
        Updates message with new data

        Sends events:
        - message.updated
        - message.updated
      operationId: UpdateMessage
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Message ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "004.001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMessageRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMessageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update message
      tags:
      - product:chat
    put:
      description: |
        Updates certain fields of the message

        Sends events:
        - message.updated
        - message.updated
      operationId: UpdateMessagePartial
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "003.001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMessagePartialRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMessagePartialResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Partially message update
      tags:
      - product:chat
  /messages/{id}/action:
    post:
      description: |
        Executes message command action with given parameters

        Sends events:
        - message.new
        - message.new
      operationId: RunMessageAction
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Message ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageActionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Run message command action
      tags:
      - product:chat
  /messages/{id}/reaction:
    post:
      description: |
        Sends reaction to specified message

        Sends events:
        - reaction.new
        - reaction.updated
      operationId: SendReaction
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Message ID to send reaction for
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendReactionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendReactionResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Send reaction
      tags:
      - product:chat
  /messages/{id}/reaction/{type}:
    delete:
      description: |
        Removes user reaction from the message

        Sends events:
        - reaction.deleted
      operationId: DeleteReaction
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Message ID to remove reaction from
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: path
        name: type
        required: true
        schema:
          description: Reaction type to remove
          title: Type
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: user_id
        schema:
          description: '**Server-side only**. User ID which server acts upon'
          title: User ID
          type: string
          writeOnly: true
          x-stream-index: "003"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteReactionResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete reaction
      tags:
      - product:chat
  /messages/{id}/reactions:
    get:
      description: |
        Returns list of reactions of specific message
      operationId: GetReactions
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Message ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: limit
        schema:
          description: Number of records to return
          format: int32
          title: Limit
          type: integer
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: offset
        schema:
          description: Number of records to offset
          format: int32
          title: Offset
          type: integer
          writeOnly: true
          x-stream-index: "003"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReactionsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get reactions
      tags:
      - product:chat
    post:
      description: |
        Get reactions on a message
      operationId: QueryReactions
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryReactionsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryReactionsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      tags:
      - product:chat
  /messages/{id}/translate:
    post:
      description: |
        Translates message to a given language using automated translation software

        Sends events:
        - message.updated
        - message.updated
      operationId: TranslateMessage
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Message ID
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "002.001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TranslateMessageRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Translate message
      tags:
      - product:chat
  /messages/{message_id}/polls/{poll_id}/vote:
    post:
      description: |
        Cast a vote on a poll

        Sends events:
        - feeds.poll.vote_casted
        - feeds.poll.vote_changed
        - feeds.poll.vote_removed
        - poll.vote_casted
        - poll.vote_changed
        - poll.vote_removed
      operationId: CastPollVote
      parameters:
      - in: path
        name: message_id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "003"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CastPollVoteRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollVoteResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Cast vote
      tags:
      - product:chat
  /messages/{message_id}/polls/{poll_id}/vote/{vote_id}:
    delete:
      description: |
        Delete a vote from a poll

        Sends events:
        - feeds.poll.vote_removed
        - poll.vote_removed
      operationId: DeletePollVote
      parameters:
      - in: path
        name: message_id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "004"
      - in: path
        name: vote_id
        required: true
        schema:
          description: Vote ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "005"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollVoteResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete vote
      tags:
      - product:chat
  /messages/{message_id}/reminders:
    delete:
      description: |
        Deletes a user's created reminder

        Sends events:
        - reminder.deleted
      operationId: DeleteReminder
      parameters:
      - in: path
        name: message_id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteReminderResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete reminder
      tags:
      - product:chat
    patch:
      description: |
        Updates an existing reminder

        Sends events:
        - reminder.updated
      operationId: UpdateReminder
      parameters:
      - in: path
        name: message_id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReminderRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateReminderResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Updates Reminder
      tags:
      - product:chat
    post:
      description: |
        Creates a new reminder

        Sends events:
        - reminder.created
      operationId: CreateReminder
      parameters:
      - in: path
        name: message_id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "002"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReminderRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReminderResponseData'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create reminder
      tags:
      - product:chat
  /messages/{parent_id}/replies:
    get:
      description: |
        Returns replies (thread) of the message
      operationId: GetReplies
      parameters:
      - in: path
        name: parent_id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: sort
        schema:
          items:
            $ref: '#/components/schemas/SortParamRequest'
          maximum: 1
          type: array
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: limit
        schema:
          format: int32
          minimum: 0
          type: integer
          writeOnly: true
          x-stream-index: "003"
      - in: query
        name: id_gte
        schema:
          type: string
          writeOnly: true
          x-stream-index: "004"
      - in: query
        name: id_gt
        schema:
          type: string
          writeOnly: true
          x-stream-index: "005"
      - in: query
        name: id_lte
        schema:
          type: string
          writeOnly: true
          x-stream-index: "006"
      - in: query
        name: id_lt
        schema:
          type: string
          writeOnly: true
          x-stream-index: "007"
      - in: query
        name: id_around
        schema:
          type: string
          writeOnly: true
          x-stream-index: "008"
      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

        Sends events:
        - user.unbanned
        - user.unbanned
      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

        Sends events:
        - user.banned
        - user.messages.deleted
        - user.banned
      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

        Sends events:
        - message.flagged
        - user.flagged
        - message.flagged
        - user.flagged
      operationId: Flag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlagRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlagMessageResponse'
          description: Successful response
        "400":
          content:
            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
      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

        Sends events:
        - user.unmuted
        - user.muted
      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

        Sends events:
        - channel.muted
        - channel.muted
      operationId: MuteChannel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MuteChannelRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MuteChannelResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Mute channel
      tags:
      - product:chat
  /moderation/unmute:
    post:
      description: |
        Unmutes previously muted user

        Sends events:
        - user.unmuted
        - user.unmuted
      operationId: UnmuteUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnmuteUserRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnmuteUserResponse'
          description: Successful response
        "400":
          content:
            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

        Sends events:
        - channel.unmuted
        - channel.unmuted
      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
      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
      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

        Sends events:
        - feeds.poll.closed
        - feeds.poll.updated
        - poll.closed
        - poll.updated
      operationId: UpdatePoll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePollRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update poll
      tags:
      - product:chat
  /polls/{poll_id}:
    delete:
      description: |
        Deletes a poll

        Sends events:
        - feeds.poll.deleted
        - poll.deleted
      operationId: DeletePoll
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete poll
      tags:
      - product:chat
    get:
      description: |
        Retrieves a poll
      operationId: GetPoll
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get poll
      tags:
      - product:chat
    patch:
      description: |
        Updates a poll partially

        Sends events:
        - feeds.poll.closed
        - feeds.poll.updated
        - poll.closed
        - poll.updated
      operationId: UpdatePollPartial
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePollPartialRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Partial update poll
      tags:
      - product:chat
  /polls/{poll_id}/options:
    post:
      description: |
        Creates a poll option

        Sends events:
        - feeds.poll.updated
        - poll.updated
      operationId: CreatePollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePollOptionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollOptionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create poll option
      tags:
      - product:chat
    put:
      description: |
        Updates a poll option

        Sends events:
        - feeds.poll.updated
        - poll.updated
      operationId: UpdatePollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePollOptionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollOptionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update poll option
      tags:
      - product:chat
  /polls/{poll_id}/options/{option_id}:
    delete:
      description: |
        Deletes a poll option

        Sends events:
        - feeds.poll.updated
        - poll.updated
      operationId: DeletePollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: path
        name: option_id
        required: true
        schema:
          description: Option ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "003"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete poll option
      tags:
      - product:chat
    get:
      description: |
        Retrieves a poll option
      operationId: GetPollOption
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: path
        name: option_id
        required: true
        schema:
          description: Option ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "003"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollOptionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get poll option
      tags:
      - product:chat
  /polls/{poll_id}/votes:
    post:
      description: |
        Queries votes
      operationId: QueryPollVotes
      parameters:
      - in: path
        name: poll_id
        required: true
        schema:
          description: Poll ID
          maxLength: 255
          title: string
          type: string
          x-stream-index: "002"
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryPollVotesRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollVotesResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query votes
      tags:
      - product:chat
  /polls/query:
    post:
      description: |
        Queries polls
      operationId: QueryPolls
      parameters:
      - in: query
        name: user_id
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryPollsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPollsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query polls
      tags:
      - product:chat
  /push_preferences:
    post:
      description: |
        Upserts the push preferences for a user and or channel member. Set to all, mentions or none
      operationId: UpdatePushNotificationPreferences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertPushPreferencesRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertPushPreferencesResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Push notification preferences
      tags:
      - product:chat
  /query_banned_users:
    get:
      description: |
        Find and filter channel scoped or global user bans
      operationId: QueryBannedUsers
      parameters:
      - content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryBannedUsersPayload'
              description: JSON object with query user bans payload
              title: Payload
              x-stream-index: "001"
        in: query
        name: payload
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBannedUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query Banned Users
      tags:
      - product:chat
  /reminders/query:
    post:
      description: |
        Queries reminders
      operationId: QueryReminders
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRemindersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryRemindersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query reminders
      tags:
      - product:chat
  /search:
    get:
      description: |
        Search messages across channels
      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
      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
      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
      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

        Sends events:
        - thread.updated
        - thread.updated
      operationId: UpdateThreadPartial
      parameters:
      - in: path
        name: message_id
        required: true
        schema:
          type: string
          writeOnly: true
          x-stream-index: "001"
      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
      operationId: UnreadCounts
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WrappedUnreadCountsResponse'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Unread counts
      tags:
      - product:chat
  /uploads/file:
    delete:
      description: |
        Deletes previously uploaded file
      operationId: DeleteFile
      parameters:
      - in: query
        name: url
        schema:
          description: File URL to delete
          title: URL
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete file
      tags:
      - product:chat
    post:
      description: |
        Uploads file
      operationId: UploadFile
      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
  /uploads/image:
    delete:
      description: |
        Deletes previously uploaded image
      operationId: DeleteImage
      parameters:
      - in: query
        name: url
        schema:
          description: File URL to delete
          title: URL
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
          description: Response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete image
      tags:
      - product:chat
    post:
      description: |
        Uploads image
      operationId: UploadImage
      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
  /users:
    get:
      description: |
        Find and filter users
      operationId: QueryUsers
      parameters:
      - content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryUsersPayload'
              x-stream-index: "001"
        in: query
        name: payload
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query users
      tags:
      - product:chat
    patch:
      description: |
        Updates certain fields of the user

        Sends events:
        - user.presence.changed
        - user.updated
        - user.presence.changed
      operationId: UpdateUsersPartial
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUsersPartialRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Partially update user
      tags:
      - product:chat
    post:
      description: |
        Update or create users in bulk

        Sends events:
        - user.updated
      operationId: UpdateUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Upsert users
      tags:
      - product:chat
  /users/block:
    get:
      description: |
        Get list of blocked Users
      operationId: GetBlockedUsers
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBlockedUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get list of blocked Users
      tags:
      - product:chat
    post:
      description: |
        Block users
      operationId: BlockUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Block user
      tags:
      - product:chat
  /users/live_locations:
    get:
      description: |
        Retrieves all active live locations for a user
      operationId: GetUserLiveLocations
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedLocationsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get user live locations
      tags:
      - product:chat
    put:
      description: |
        Updates an existing live location with new coordinates or expiration time
      operationId: UpdateLiveLocation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLiveLocationRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedLocationResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update live location
      tags:
      - product:chat
  /users/unblock:
    post:
      description: |
        Unblock users
      operationId: UnblockUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnblockUsersRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnblockUsersResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Unblock user
      tags:
      - product:chat
security:
- JWT: []
  api_key: []
  stream-auth-type: []
- api_key: []
  stream-auth-type: []
servers:
- description: Stream API
  url: https://chat.stream-io-api.com