components:
  schemas:
    APIError:
      nullable: true
      properties:
        StatusCode:
          description: Response HTTP status code
          format: int32
          title: Status code
          type: integer
          x-stream-index: "004"
        code:
          description: API error code
          format: int32
          title: Code
          type: integer
          x-stream-index: "001"
        details:
          description: Additional error-specific information
          items:
            type: integer
          title: Details
          type: array
          x-stream-index: "007"
        duration:
          description: Request duration
          title: Duration
          type: string
          x-stream-index: "005"
        exception_fields:
          additionalProperties:
            type: string
          description: Additional error info
          title: Exception fields
          type: object
          x-stream-index: "003"
        message:
          description: Message describing an error
          title: Message
          type: string
          x-stream-index: "002"
        more_info:
          description: URL with additional information
          title: More info
          type: string
          x-stream-index: "006"
        unrecoverable:
          description: Flag that indicates if the error is unrecoverable, requests
            that return unrecoverable errors should not be retried, this error only
            applies to the request that caused it
          title: Unrecoverable
          type: boolean
          x-stream-index: "008"
      required:
      - code
      - message
      - StatusCode
      - duration
      - more_info
      - details
      title: Error response
      type: object
    Action:
      nullable: true
      properties:
        name:
          type: string
          x-stream-index: "001"
        style:
          type: string
          x-stream-index: "003"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "004"
        value:
          type: string
          x-stream-index: "005"
      required:
      - name
      - text
      - type
      type: object
    ActionLogResponse:
      nullable: true
      properties:
        ai_providers:
          items:
            type: string
          type: array
          x-stream-index: "012"
        created_at:
          description: Timestamp when the action was taken
          format: date-time
          title: Created At
          type: string
          x-stream-index: "002"
        custom:
          additionalProperties: {}
          description: Additional metadata about the action
          title: Custom
          type: object
          x-stream-index: "008"
        id:
          description: Unique identifier of the action log
          title: ID
          type: string
          x-stream-index: "001"
        reason:
          description: Reason for the moderation action
          title: Reason
          type: string
          x-stream-index: "007"
        reporter_type:
          description: Classification of who triggered the action (e.g. user, moderator,
            automod, api_integration)
          title: Reporter Type
          type: string
          x-stream-index: "006"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: Associated review queue item
          title: Review Queue Item
          x-stream-index: "009"
        target_user:
          $ref: '#/components/schemas/UserResponse'
          description: User who was the target of the action
          title: Target User
          x-stream-index: "010"
        target_user_id:
          description: ID of the user who was the target of the action
          title: Target User ID
          type: string
          x-stream-index: "011"
        type:
          description: Type of moderation action
          title: Type
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who performed the action
          title: User
          x-stream-index: "004"
        user_id:
          description: ID of the user who performed the action
          title: User ID
          type: string
          x-stream-index: "005"
      required:
      - id
      - created_at
      - type
      - user_id
      - reporter_type
      - reason
      - custom
      - target_user_id
      - ai_providers
      type: object
    AppealAcceptedEvent:
      description: This event is sent when an appeal is accepted
      nullable: true
      properties:
        appeal:
          $ref: '#/components/schemas/AppealItemResponse'
          description: The appeal that was accepted
          title: Appeal
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        type:
          default: appeal.accepted
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      title: AppealAcceptedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AppealCreatedEvent:
      description: This event is sent when an appeal is created
      nullable: true
      properties:
        appeal:
          $ref: '#/components/schemas/AppealItemResponse'
          description: The appeal that was created
          title: Appeal
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        type:
          default: appeal.created
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      title: AppealCreatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AppealItemResponse:
      properties:
        appeal_reason:
          description: Reason Text of the Appeal Item
          title: Appeal Reason
          type: string
          x-stream-index: "006"
        attachments:
          description: Attachments(e.g. Images) of the Appeal Item
          items:
            type: string
          title: Attachments
          type: array
          x-stream-index: "009"
        created_at:
          description: When the flag was created
          format: date-time
          title: Created At
          type: string
          x-stream-index: "010"
        decision_reason:
          description: Decision Reason of the Appeal Item
          title: Decision Reason
          type: string
          x-stream-index: "008"
        entity_content:
          $ref: '#/components/schemas/ModerationPayload'
          x-stream-index: "005"
        entity_id:
          description: ID of the entity
          title: Entity ID
          type: string
          x-stream-index: "004"
        entity_type:
          description: Type of entity
          title: Entity Type
          type: string
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        status:
          description: Status of the Appeal Item
          title: Status
          type: string
          x-stream-index: "007"
        updated_at:
          description: When the flag was last updated
          format: date-time
          title: Updated At
          type: string
          x-stream-index: "011"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Details of the user who created the appeal
          title: User
          x-stream-index: "002"
      required:
      - id
      - entity_type
      - entity_id
      - appeal_reason
      - status
      - created_at
      - updated_at
      type: object
    AppealRejectedEvent:
      description: This event is sent when an appeal is rejected
      nullable: true
      properties:
        appeal:
          $ref: '#/components/schemas/AppealItemResponse'
          description: The appeal that was rejected
          title: Appeal
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        type:
          default: appeal.rejected
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      title: AppealRejectedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncBulkImageModerationEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        finished_at:
          format: date-time
          type: string
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.bulk_image_moderation.success
          type: string
          x-stream-index: "003.002"
        url:
          type: string
          x-stream-index: "001"
      required:
      - url
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncBulkImageModerationEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncExportErrorEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        error:
          type: string
          x-stream-index: "001"
        finished_at:
          format: date-time
          type: string
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.moderation_logs.error
          type: string
          x-stream-index: "003.002"
      required:
      - error
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncExportErrorEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncExportModerationLogsEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        finished_at:
          format: date-time
          type: string
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: string
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.moderation_logs.success
          type: string
          x-stream-index: "003.002"
        url:
          type: string
          x-stream-index: "001"
      required:
      - url
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncExportModerationLogsEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    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
    BanInfoResponse:
      description: Ban information
      nullable: true
      properties:
        created_at:
          description: When the ban was created
          format: date-time
          title: Created At
          type: string
          x-stream-index: "006"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the ban
          title: Created By
          x-stream-index: "005"
        expires:
          description: When the ban expires
          format: date-time
          title: Expires
          type: string
          x-stream-index: "002"
        reason:
          description: Reason for the ban
          title: Reason
          type: string
          x-stream-index: "003"
        shadow:
          description: Whether this is a shadow ban
          title: Shadow
          type: boolean
          x-stream-index: "004"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The banned user
          title: User
          x-stream-index: "001"
      required:
      - created_at
      title: BanInfo
      type: object
    BlockListOptions:
      properties:
        behavior:
          description: 'Blocklist behavior. One of: flag, block, shadow_block'
          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
    CallResponse:
      properties:
        backstage:
          type: boolean
          x-stream-index: "007"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "009"
        captioning:
          type: boolean
          x-stream-index: "017"
        channel_cid:
          type: string
          x-stream-index: "014"
        cid:
          type: string
          x-stream-index: "001"
        created_at:
          format: date-time
          type: string
          x-stream-index: "004"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "010"
        current_session_id:
          type: string
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "008"
        ended_at:
          format: date-time
          type: string
          x-stream-index: "011"
        id:
          type: string
          x-stream-index: "002"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "019"
        recording:
          type: boolean
          x-stream-index: "015"
        routing_number:
          type: string
          x-stream-index: "020"
        starts_at:
          format: date-time
          type: string
          x-stream-index: "012"
        team:
          type: string
          x-stream-index: "013"
        transcribing:
          type: boolean
          x-stream-index: "016"
        translating:
          type: boolean
          x-stream-index: "018"
        type:
          type: string
          x-stream-index: "003"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "005"
      required:
      - cid
      - id
      - type
      - created_at
      - updated_at
      - current_session_id
      - backstage
      - custom
      - blocked_user_ids
      - recording
      - transcribing
      - captioning
      - translating
      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
        chat_preferences:
          $ref: '#/components/schemas/ChatPreferences'
          x-stream-index: 001.002.034
        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_level:
          enum:
          - all
          - all_mentions
          - mentions
          - direct_mentions
          - none
          type: string
          x-stream-index: 001.002.033
        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
    ChannelMemberResponse:
      properties:
        channel_role:
          type: string
          x-stream-index: "001"
        notifications_muted:
          type: boolean
          x-stream-index: "002"
      required:
      - channel_role
      - notifications_muted
      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
    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
    ChatDraftPayloadResponse:
      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
    ChatDraftResponse:
      properties:
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "006"
        message:
          $ref: '#/components/schemas/ChatDraftPayloadResponse'
          x-stream-index: "001"
        parent_id:
          type: string
          x-stream-index: "003"
        parent_message:
          $ref: '#/components/schemas/ChatMessageResponse'
          x-stream-index: "004"
        quoted_message:
          $ref: '#/components/schemas/ChatMessageResponse'
          x-stream-index: "005"
      required:
      - message
      - channel_cid
      - created_at
      type: object
    ChatMessageResponse:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "009"
        cid:
          type: string
          x-stream-index: "022"
        command:
          type: string
          x-stream-index: "004"
        created_at:
          format: date-time
          type: string
          x-stream-index: "023"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "026"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "025"
        deleted_for_me:
          type: boolean
          x-stream-index: "048"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "018"
        draft:
          $ref: '#/components/schemas/ChatDraftResponse'
          x-stream-index: "045"
        html:
          type: string
          x-stream-index: "005"
        i18n:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "034"
        id:
          type: string
          x-stream-index: "001"
        image_labels:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "028"
        latest_reactions:
          items:
            $ref: '#/components/schemas/ChatReactionResponse'
          type: array
          x-stream-index: "010"
        member:
          $ref: '#/components/schemas/ChannelMemberResponse'
          x-stream-index: "008"
        mentioned_channel:
          type: boolean
          x-stream-index: "032"
        mentioned_group_ids:
          items:
            type: string
          type: array
          x-stream-index: "031"
        mentioned_here:
          type: boolean
          x-stream-index: "033"
        mentioned_roles:
          items:
            type: string
          type: array
          x-stream-index: "030"
        mentioned_users:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "029"
        message_text_updated_at:
          format: date-time
          type: string
          x-stream-index: "040"
        mml:
          type: string
          x-stream-index: "003"
        moderation:
          $ref: '#/components/schemas/ChatModerationV2Response'
          x-stream-index: "043"
        own_reactions:
          items:
            $ref: '#/components/schemas/ChatReactionResponse'
          type: array
          x-stream-index: "011"
        parent_id:
          type: string
          x-stream-index: "015"
        pin_expires:
          format: date-time
          type: string
          x-stream-index: "039"
        pinned:
          type: boolean
          x-stream-index: "036"
        pinned_at:
          format: date-time
          type: string
          x-stream-index: "037"
        pinned_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "038"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "042"
        poll_id:
          type: string
          x-stream-index: "041"
        quoted_message:
          $ref: '#/components/schemas/ChatMessageResponse'
          x-stream-index: "020"
        quoted_message_id:
          type: string
          x-stream-index: "019"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "012"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ChatReactionGroupResponse'
          type: object
          x-stream-index: "014"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "013"
        reminder:
          $ref: '#/components/schemas/ChatReminderResponseData'
          x-stream-index: "046"
        reply_count:
          format: int32
          type: integer
          x-stream-index: "017"
        restricted_visibility:
          items:
            type: string
          type: array
          x-stream-index: "044"
        shadowed:
          type: boolean
          x-stream-index: "027"
        shared_location:
          $ref: '#/components/schemas/ChatSharedLocationResponseData'
          x-stream-index: "047"
        show_in_channel:
          type: boolean
          x-stream-index: "016"
        silent:
          type: boolean
          x-stream-index: "035"
        text:
          type: string
          x-stream-index: "002"
        thread_participants:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "021"
        type:
          type: string
          x-stream-index: "006"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "024"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "007"
      required:
      - id
      - text
      - html
      - type
      - user
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - mentioned_channel
      - mentioned_here
      - silent
      - pinned
      - restricted_visibility
      type: object
    ChatMessageTaskResponse:
      description: Chat message task response
      properties:
        assigned_to:
          description: The person that this task is assigned to
          title: Assigned To
          type: string
          x-stream-index: "014"
        channel_id:
          description: The Channel ID
          title: Channel ID
          type: string
          x-stream-index: "004"
        channel_name:
          description: The Channel Name, if not provided matches the Channel ID
          title: Channel Name
          type: string
          x-stream-index: "006"
        content_type:
          description: Type of payload for this task
          title: Content Type
          type: string
          x-stream-index: "009"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "017"
        evaluations:
          description: a list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/EvaluationResponse'
          title: Evaluations
          type: array
          x-stream-index: "011"
        extra:
          additionalProperties: {}
          description: Extra data that needs to be stored for this task
          title: Extra
          type: object
          x-stream-index: "010"
        id:
          description: 'Task ID '
          title: ID
          type: string
          x-stream-index: "001"
        message_id:
          description: The ID of the message so the system can know on which message
            to act if moderation is needed
          title: Message ID
          type: string
          x-stream-index: "002"
        reviewed_at:
          description: The time when the review happened
          format: date-time
          title: Reviewed At
          type: string
          x-stream-index: "015"
        reviewed_by:
          description: The person who did the review
          title: Reviewed By
          type: string
          x-stream-index: "016"
        rule:
          $ref: '#/components/schemas/RuleResponse'
          title: Rule
          x-stream-index: "012"
        status:
          description: Status of the task. Sync tasks can be completed or error, async
            tasks can be in pending state
          title: Status
          type: string
          x-stream-index: "007"
        text:
          description: The message text sent for evaluation
          title: Text
          type: string
          x-stream-index: "008"
        triggers:
          description: A list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/TriggerResponse'
          title: Triggers
          type: array
          x-stream-index: "013"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "018"
        user_id:
          description: The User ID
          title: User ID
          type: string
          x-stream-index: "003"
        user_name:
          description: The User Name, if not provided matches the User ID
          title: User Name
          type: string
          x-stream-index: "005"
      required:
      - id
      - message_id
      - user_id
      - channel_id
      - user_name
      - channel_name
      - status
      - text
      - content_type
      - evaluations
      - created_at
      - updated_at
      title: ChatMessageTaskResponse
      type: object
    ChatModerationV2Response:
      properties:
        action:
          type: string
          x-stream-index: "001"
        blocklist_matched:
          type: string
          x-stream-index: "005"
        blocklists_matched:
          items:
            type: string
          type: array
          x-stream-index: "006"
        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: "008"
        semantic_filter_matched:
          type: string
          x-stream-index: "007"
        text_harms:
          items:
            type: string
          type: array
          x-stream-index: "003"
      required:
      - action
      - original_text
      type: object
    ChatPreferences:
      properties:
        channel_mentions:
          type: string
          x-stream-index: "007"
        default_preference:
          type: string
          x-stream-index: "001"
        direct_mentions:
          type: string
          x-stream-index: "002"
        distinct_channel_messages:
          type: string
          x-stream-index: "008"
        group_mentions:
          type: string
          x-stream-index: "004"
        here_mentions:
          type: string
          x-stream-index: "006"
        role_mentions:
          type: string
          x-stream-index: "003"
        thread_replies:
          type: string
          x-stream-index: "005"
      type: object
    ChatReactionGroupResponse:
      nullable: true
      properties:
        count:
          format: int32
          type: integer
          x-stream-index: "001"
        first_reaction_at:
          format: date-time
          type: string
          x-stream-index: "003"
        last_reaction_at:
          format: date-time
          type: string
          x-stream-index: "004"
        latest_reactions_by:
          items:
            $ref: '#/components/schemas/ChatReactionGroupUserResponse'
          type: array
          x-stream-index: "005"
        sum_scores:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - count
      - sum_scores
      - first_reaction_at
      - last_reaction_at
      - latest_reactions_by
      type: object
    ChatReactionGroupUserResponse:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
        user_id:
          type: string
          x-stream-index: "001"
      required:
      - user_id
      - created_at
      type: object
    ChatReactionResponse:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "008"
        message_id:
          type: string
          x-stream-index: "001"
        score:
          format: int32
          type: integer
          x-stream-index: "005"
        type:
          type: string
          x-stream-index: "004"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "003"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - message_id
      - user_id
      - user
      - type
      - score
      - created_at
      - updated_at
      - custom
      type: object
    ChatReminderResponseData:
      properties:
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "007"
        message:
          $ref: '#/components/schemas/ChatMessageResponse'
          x-stream-index: "004"
        message_id:
          type: string
          x-stream-index: "003"
        remind_at:
          format: date-time
          type: string
          x-stream-index: "001"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "008"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "006"
        user_id:
          type: string
          x-stream-index: "005"
      required:
      - channel_cid
      - message_id
      - user_id
      - created_at
      - updated_at
      type: object
    ChatSharedLocationResponseData:
      properties:
        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/ChatMessageResponse'
          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
    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
    Data:
      properties:
        id:
          type: string
          x-stream-index: "001"
      required:
      - id
      type: object
    DeliveryReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    DeviceResponse:
      description: Response for Device
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "004"
        disabled:
          description: Whether device is disabled or not
          title: Disabled
          type: boolean
          x-stream-index: "005"
        disabled_reason:
          description: Reason explaining why device had been disabled
          title: Reason
          type: string
          x-stream-index: "006"
        id:
          description: Device ID
          title: ID
          type: string
          x-stream-index: "003"
        push_provider:
          description: Push provider
          title: PushProvider
          type: string
          x-stream-index: "001"
        push_provider_name:
          description: Push provider name
          title: PushProviderName
          type: string
          x-stream-index: "002"
        user_id:
          description: User ID
          title: UserID
          type: string
          x-stream-index: "008"
        voip:
          description: When true the token is for Apple VoIP push notifications
          title: Voip
          type: boolean
          x-stream-index: "007"
      required:
      - push_provider
      - id
      - created_at
      - user_id
      title: DeviceResponse
      type: object
    DraftPayloadResponse:
      description: Contains the draft message content
      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: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "007"
        html:
          description: Contains HTML markup of the message
          title: HTML content
          type: string
          x-stream-index: "010"
        id:
          description: Message ID is unique string identifier of the message
          title: ID
          type: string
          x-stream-index: "001"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "008"
        mml:
          description: MML content of the message
          title: Messaging Markup Language
          type: string
          x-stream-docs-page-id: mml_overview
          x-stream-index: "003"
        parent_id:
          description: ID of parent message (thread)
          title: Parent message ID
          type: string
          x-stream-docs-page-id: threads
          x-stream-index: "005"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "013"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "009"
        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: "006"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "012"
        text:
          description: Text of the message
          title: Text
          type: string
          x-stream-index: "002"
        type:
          description: 'Contains type of the message. One of: regular, system'
          title: Message Type
          type: string
          x-stream-docs-page-id: message_format#message-types
          x-stream-index: "011"
      required:
      - id
      - text
      - custom
      title: Draft Message Payload
      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
    EnrichedActivity:
      properties:
        actor:
          $ref: '#/components/schemas/Data'
          x-stream-index: "002"
        foreign_id:
          type: string
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        latest_reactions:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "013"
        object:
          $ref: '#/components/schemas/Data'
          x-stream-index: "004"
        origin:
          $ref: '#/components/schemas/Data'
          x-stream-index: "008"
        own_reactions:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "012"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "011"
        score:
          format: float
          type: number
          x-stream-index: "010"
        target:
          $ref: '#/components/schemas/Data'
          x-stream-index: "006"
        time:
          $ref: '#/components/schemas/Time'
          x-stream-index: "007"
        to:
          items:
            type: string
          type: array
          x-stream-index: "009"
        verb:
          type: string
          x-stream-index: "003"
      type: object
    EnrichedReaction:
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: "003"
        children_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "010"
        created_at:
          $ref: '#/components/schemas/Time'
          x-stream-index: "012"
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        kind:
          type: string
          x-stream-index: "002"
        latest_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "008"
        own_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "009"
        parent:
          type: string
          x-stream-index: "007"
        target_feeds:
          items:
            type: string
          type: array
          x-stream-index: "006"
        updated_at:
          $ref: '#/components/schemas/Time'
          x-stream-index: "013"
        user:
          $ref: '#/components/schemas/Data'
          x-stream-index: "011"
        user_id:
          type: string
          x-stream-index: "004"
      required:
      - kind
      - activity_id
      - user_id
      type: object
    EntityCreatorResponse:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: 001.001.018
        ban_count:
          description: Number of minor actions performed on the user
          format: int32
          title: Ban Count
          type: integer
          x-stream-index: "002"
        ban_expires:
          format: date-time
          type: string
          x-stream-index: "001.004"
        banned:
          type: boolean
          x-stream-index: 001.001.012
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: 001.001.017
        bypass_moderation:
          type: boolean
          x-stream-index: "001.003"
        created_at:
          format: date-time
          type: string
          x-stream-index: 001.001.009
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.004
        deactivated_at:
          format: date-time
          type: string
          x-stream-index: 001.001.016
        deleted_at:
          format: date-time
          type: string
          x-stream-index: 001.001.011
        deleted_content_count:
          description: Number of major actions performed on the user
          format: int32
          title: Deleted Content Count
          type: integer
          x-stream-index: "003"
        devices:
          items:
            $ref: '#/components/schemas/DeviceResponse'
          type: array
          x-stream-index: "001.007"
        flagged_count:
          description: Number of flag actions performed on the user
          format: int32
          title: Flagged Count
          type: integer
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: 001.001.001
        image:
          type: string
          x-stream-index: 001.001.003
        invisible:
          type: boolean
          x-stream-index: "001.008"
        language:
          type: string
          x-stream-index: 001.001.005
        last_active:
          format: date-time
          type: string
          x-stream-index: 001.001.014
        name:
          type: string
          x-stream-index: 001.001.002
        online:
          type: boolean
          x-stream-index: 001.001.013
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "001.006"
        push_notifications:
          $ref: '#/components/schemas/PushNotificationSettingsResponse'
          x-stream-index: "001.005"
        revoke_tokens_issued_before:
          format: date-time
          type: string
          x-stream-index: 001.001.015
        role:
          type: string
          x-stream-index: 001.001.006
        shadow_banned:
          type: boolean
          x-stream-index: "001.002"
        teams:
          items:
            type: string
          type: array
          x-stream-index: 001.001.007
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: 001.001.008
        updated_at:
          format: date-time
          type: string
          x-stream-index: 001.001.010
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      - shadow_banned
      - invisible
      - ban_count
      - deleted_content_count
      - flagged_count
      type: object
    EscalationMetadata:
      properties:
        notes:
          type: string
          x-stream-index: "002"
        priority:
          type: string
          x-stream-index: "003"
        reason:
          type: string
          x-stream-index: "001"
      type: object
    EvaluationPayload:
      nullable: true
      properties:
        matches:
          description: List of matches
          items:
            $ref: '#/components/schemas/MatchPayload'
          title: Matches
          type: array
          x-stream-index: "005"
        phrase_list_ids:
          description: List of phrase list IDs
          items:
            format: int32
            type: integer
          title: Phrase List IDs
          type: array
          x-stream-index: "003"
        phrases:
          description: List of matched phrases
          items:
            type: string
          title: Phrases
          type: array
          x-stream-index: "004"
        score:
          description: Evaluation score
          format: float
          title: Score
          type: number
          x-stream-index: "002"
        type:
          description: Evaluation type
          enum:
          - spam_commercial
          - platform_circumvention
          - semantic_filter
          title: Type
          type: string
          x-stream-index: "001"
      required:
      - type
      title: EvaluationPayload
      type: object
    EvaluationResponse:
      properties:
        matches:
          items:
            $ref: '#/components/schemas/MatchResponse'
          type: array
          x-stream-index: "003"
        score:
          format: float
          type: number
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "001"
      required:
      - type
      - score
      type: object
    FeedsActivityLocation:
      properties:
        lat:
          format: float
          type: number
          x-stream-index: "001"
        lng:
          format: float
          type: number
          x-stream-index: "002"
      required:
      - lat
      - lng
      type: object
    FeedsBookmarkResponse:
      properties:
        activity_id:
          type: string
          x-stream-index: "007"
        created_at:
          format: date-time
          type: string
          x-stream-index: "005"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        object_id:
          type: string
          x-stream-index: "002"
        object_type:
          type: string
          x-stream-index: "001"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "006"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "003"
      required:
      - object_type
      - object_id
      - user
      - created_at
      - updated_at
      type: object
    FeedsEnrichedCollectionResponse:
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.005"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.003"
        id:
          type: string
          x-stream-index: "001.002"
        name:
          type: string
          x-stream-index: "001.001"
        status:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "001.006"
        user_id:
          type: string
          x-stream-index: "001.004"
      required:
      - name
      - id
      - custom
      - user_id
      - created_at
      - updated_at
      - status
      type: object
    FeedsFeedResponse:
      properties:
        activity_count:
          format: int32
          type: integer
          x-stream-index: "014"
        created_at:
          format: date-time
          type: string
          x-stream-index: "016"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "010"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "018"
        description:
          type: string
          x-stream-index: "005"
        feed:
          type: string
          x-stream-index: "003"
        filter_tags:
          items:
            type: string
          type: array
          x-stream-index: "008"
        follower_count:
          format: int32
          type: integer
          x-stream-index: "012"
        following_count:
          format: int32
          type: integer
          x-stream-index: "013"
        group_id:
          type: string
          x-stream-index: "001"
        id:
          type: string
          x-stream-index: "002"
        location:
          $ref: '#/components/schemas/FeedsActivityLocation'
          x-stream-index: "007"
        member_count:
          format: int32
          type: integer
          x-stream-index: "011"
        name:
          type: string
          x-stream-index: "004"
        pin_count:
          format: int32
          type: integer
          x-stream-index: "015"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "017"
        visibility:
          type: string
          x-stream-index: "009"
      required:
      - group_id
      - id
      - feed
      - name
      - description
      - created_by
      - member_count
      - follower_count
      - following_count
      - activity_count
      - pin_count
      - created_at
      - updated_at
      type: object
    FeedsNotificationComment:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "004"
        comment:
          type: string
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - id
      - user_id
      - comment
      type: object
    FeedsNotificationContext:
      properties:
        target:
          $ref: '#/components/schemas/FeedsNotificationTarget'
          x-stream-index: "002"
        trigger:
          $ref: '#/components/schemas/FeedsNotificationTrigger'
          x-stream-index: "001"
      type: object
    FeedsNotificationParentActivity:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "004"
        type:
          type: string
          x-stream-index: "003"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - id
      type: object
    FeedsNotificationTarget:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "005"
        comment:
          $ref: '#/components/schemas/FeedsNotificationComment'
          x-stream-index: "007"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "009"
        id:
          type: string
          x-stream-index: "001"
        name:
          type: string
          x-stream-index: "006"
        parent_activity:
          $ref: '#/components/schemas/FeedsNotificationParentActivity'
          x-stream-index: "008"
        text:
          type: string
          x-stream-index: "004"
        type:
          type: string
          x-stream-index: "003"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - id
      type: object
    FeedsNotificationTrigger:
      properties:
        comment:
          $ref: '#/components/schemas/FeedsNotificationComment'
          x-stream-index: "003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "001"
      required:
      - type
      - text
      type: object
    FeedsReactionGroupResponse:
      properties:
        count:
          format: int32
          type: integer
          x-stream-index: "001"
        first_reaction_at:
          format: date-time
          type: string
          x-stream-index: "002"
        last_reaction_at:
          format: date-time
          type: string
          x-stream-index: "003"
      required:
      - count
      - first_reaction_at
      - last_reaction_at
      type: object
    FeedsReactionResponse:
      properties:
        activity_id:
          type: string
          x-stream-index: "002"
        comment_id:
          type: string
          x-stream-index: "003"
        created_at:
          format: date-time
          type: string
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "005"
        type:
          type: string
          x-stream-index: "004"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
      required:
      - user
      - activity_id
      - type
      - created_at
      - updated_at
      type: object
    FeedsV3ActivityResponse:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "010"
        bookmark_count:
          format: int32
          type: integer
          x-stream-index: "032"
        collections:
          additionalProperties:
            $ref: '#/components/schemas/FeedsEnrichedCollectionResponse'
          type: object
          x-stream-index: "040"
        comment_count:
          format: int32
          type: integer
          x-stream-index: "031"
        comments:
          items:
            $ref: '#/components/schemas/FeedsV3CommentResponse'
          type: array
          x-stream-index: "018"
        created_at:
          format: date-time
          type: string
          x-stream-index: "008"
        current_feed:
          $ref: '#/components/schemas/FeedsFeedResponse'
          x-stream-index: "043"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "012"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "024"
        edited_at:
          format: date-time
          type: string
          x-stream-index: "023"
        expires_at:
          format: date-time
          type: string
          x-stream-index: "025"
        feeds:
          items:
            type: string
          type: array
          x-stream-index: "004"
        filter_tags:
          items:
            type: string
          type: array
          x-stream-index: "027"
        friend_reaction_count:
          format: int32
          type: integer
          x-stream-index: "042"
        friend_reactions:
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          type: array
          x-stream-index: "041"
        hidden:
          type: boolean
          x-stream-index: "044"
        id:
          type: string
          x-stream-index: "001"
        interest_tags:
          items:
            type: string
          type: array
          x-stream-index: "028"
        is_read:
          type: boolean
          x-stream-index: "048"
        is_seen:
          type: boolean
          x-stream-index: "047"
        is_watched:
          type: boolean
          x-stream-index: "046"
        latest_reactions:
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          type: array
          x-stream-index: "036"
        location:
          $ref: '#/components/schemas/FeedsActivityLocation'
          x-stream-index: "020"
        mentioned_users:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "011"
        metrics:
          additionalProperties:
            format: int64
            type: integer
          type: object
          x-stream-index: "035"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "029"
        moderation_action:
          type: string
          x-stream-index: "030"
        notification_context:
          $ref: '#/components/schemas/FeedsNotificationContext'
          x-stream-index: "013"
        own_bookmarks:
          items:
            $ref: '#/components/schemas/FeedsBookmarkResponse'
          type: array
          x-stream-index: "039"
        own_reactions:
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          type: array
          x-stream-index: "038"
        parent:
          $ref: '#/components/schemas/FeedsV3ActivityResponse'
          x-stream-index: "021"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "022"
        popularity:
          format: int32
          type: integer
          x-stream-index: "014"
        preview:
          type: boolean
          x-stream-index: "045"
        reaction_count:
          format: int32
          type: integer
          x-stream-index: "034"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/FeedsReactionGroupResponse'
          type: object
          x-stream-index: "037"
        restrict_replies:
          type: string
          x-stream-index: "007"
        score:
          format: float
          type: number
          x-stream-index: "015"
        score_vars:
          additionalProperties: {}
          type: object
          x-stream-index: "016"
        search_data:
          additionalProperties: {}
          type: object
          x-stream-index: "026"
        selector_source:
          type: string
          x-stream-index: "017"
        share_count:
          format: int32
          type: integer
          x-stream-index: "033"
        text:
          type: string
          x-stream-index: "019"
        type:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "003"
        visibility:
          type: string
          x-stream-index: "005"
        visibility_tag:
          type: string
          x-stream-index: "006"
      required:
      - id
      - type
      - user
      - feeds
      - visibility
      - restrict_replies
      - created_at
      - updated_at
      - attachments
      - mentioned_users
      - custom
      - popularity
      - score
      - comments
      - search_data
      - filter_tags
      - interest_tags
      - comment_count
      - bookmark_count
      - share_count
      - reaction_count
      - latest_reactions
      - reaction_groups
      - own_reactions
      - own_bookmarks
      - collections
      - hidden
      - preview
      type: object
    FeedsV3CommentResponse:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "011"
        bookmark_count:
          format: int32
          type: integer
          x-stream-index: "022"
        confidence_score:
          format: float
          type: number
          x-stream-index: "024"
        controversy_score:
          format: float
          type: number
          x-stream-index: "025"
        created_at:
          format: date-time
          type: string
          x-stream-index: "014"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "017"
        downvote_count:
          format: int32
          type: integer
          x-stream-index: "021"
        edited_at:
          format: date-time
          type: string
          x-stream-index: "016"
        id:
          type: string
          x-stream-index: "001"
        latest_reactions:
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          type: array
          x-stream-index: "009"
        mentioned_users:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "012"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "018"
        object_id:
          type: string
          x-stream-index: "002"
        object_type:
          type: string
          x-stream-index: "003"
        own_reactions:
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          type: array
          x-stream-index: "026"
        parent_id:
          type: string
          x-stream-index: "007"
        reaction_count:
          format: int32
          type: integer
          x-stream-index: "008"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/FeedsReactionGroupResponse'
          type: object
          x-stream-index: "010"
        reply_count:
          format: int32
          type: integer
          x-stream-index: "019"
        score:
          format: int32
          type: integer
          x-stream-index: "023"
        status:
          type: string
          x-stream-index: "013"
        text:
          type: string
          x-stream-index: "005"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "015"
        upvote_count:
          format: int32
          type: integer
          x-stream-index: "020"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "004"
      required:
      - id
      - object_id
      - object_type
      - user
      - reaction_count
      - mentioned_users
      - status
      - created_at
      - updated_at
      - reply_count
      - upvote_count
      - downvote_count
      - bookmark_count
      - score
      - confidence_score
      - own_reactions
      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
    GetTaskResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        task:
          $ref: '#/components/schemas/TaskResponse'
          title: Task
          x-stream-index: "001"
      required:
      - task
      - duration
      title: GetTaskResponse
      type: object
    ImageData:
      properties:
        frames:
          type: string
          x-stream-index: "005"
        height:
          type: string
          x-stream-index: "003"
        size:
          type: string
          x-stream-index: "004"
        url:
          type: string
          x-stream-index: "001"
        width:
          type: string
          x-stream-index: "002"
      required:
      - url
      - width
      - height
      - size
      - frames
      type: object
    Images:
      properties:
        fixed_height:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "002"
        fixed_height_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "004"
        fixed_height_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "003"
        fixed_width:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "005"
        fixed_width_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "007"
        fixed_width_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "006"
        original:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "001"
      required:
      - original
      - fixed_height
      - fixed_height_still
      - fixed_height_downsampled
      - fixed_width
      - fixed_width_still
      - fixed_width_downsampled
      type: object
    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
    ListTasksResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        tasks:
          description: A collection of all tasks
          items:
            $ref: '#/components/schemas/TaskResponse'
          title: Tasks
          type: array
          x-stream-index: "001"
      required:
      - tasks
      - duration
      title: ListTasksResponse
      type: object
    MatchPayload:
      nullable: true
      properties:
        text:
          description: Matched text
          title: Text
          type: string
          x-stream-index: "002"
        type:
          description: Match type
          title: Type
          type: string
          x-stream-index: "001"
      title: MatchPayload
      type: object
    MatchResponse:
      properties:
        text:
          type: string
          x-stream-index: "002"
        type:
          description: Match type
          title: Type
          type: string
          x-stream-index: "001"
      required:
      - type
      - text
      title: MatchResponse
      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: "024"
        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: "025"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "028"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: string
          x-stream-index: "027"
        deleted_for_me:
          type: boolean
          x-stream-index: "050"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "020"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "047"
        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: "036"
        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: "030"
        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_channel:
          description: Whether the message mentioned the channel tag
          title: Mentioned Channel
          type: boolean
          x-stream-index: "034"
        mentioned_group_ids:
          description: List of user group IDs mentioned in the message. Group members
            who are also channel members will receive push notifications based on
            their push preferences. Max 10 groups
          items:
            type: string
          title: Mentioned Groups
          type: array
          x-stream-index: "033"
        mentioned_here:
          description: Whether the message mentioned online users with @here tag
          title: Mentioned Here
          type: boolean
          x-stream-index: "035"
        mentioned_roles:
          description: List of roles mentioned in the message (e.g. admin, channel_moderator,
            custom roles). Members with matching roles will receive push notifications
            based on their push preferences. Max 10 roles
          items:
            type: string
          title: Mentioned Roles
          type: array
          x-stream-index: "032"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "031"
        message_text_updated_at:
          format: date-time
          type: string
          x-stream-index: "042"
        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: "045"
        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: "017"
        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: "041"
        pinned:
          description: Whether message is pinned or not
          title: Pinned
          type: boolean
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "038"
        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: "039"
        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: "040"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "044"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "043"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          description: Contains quoted message
          title: Quoted message
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "022"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "021"
        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: "016"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          description: 'An object containing scores of reactions of each type. Key:
            reaction type (string), value: total score of reactions (int)'
          title: Reaction scores
          type: object
          x-stream-index: "013"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "048"
        reply_count:
          description: Number of replies to this message
          format: int32
          title: Reply count
          type: integer
          x-stream-index: "019"
        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: "046"
        shadowed:
          description: Whether the message was shadowed or not
          title: Shadowed
          type: boolean
          x-stream-docs-page-id: moderation#shadow-ban
          x-stream-index: "029"
        shared_location:
          $ref: '#/components/schemas/SharedLocationResponseData'
          description: Contains shared location data
          title: Shared Location
          x-stream-index: "049"
        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: "018"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "037"
        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: "023"
        type:
          description: 'Contains type of the message. One of: 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: "026"
        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
      - mentioned_channel
      - mentioned_here
      - silent
      - pinned
      - restricted_visibility
      title: Message
      type: object
      x-stream-docs-page-id: send_message
    ModerationCheckCompletedEvent:
      description: This event is sent when a moderation check is completed
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        entity_id:
          description: The ID of entity which was moderated
          title: EntityID
          type: string
          x-stream-index: "002"
        entity_type:
          description: The type of the entity which was moderated
          title: EntityType
          type: string
          x-stream-index: "003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        recommended_action:
          description: The recommended action
          title: RecommendedAction
          type: string
          x-stream-index: "004"
        review_queue_item_id:
          description: The review queue item ID
          title: ReviewQueueItemID
          type: string
          x-stream-index: "005"
        type:
          default: moderation_check.completed
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      - entity_id
      - entity_type
      - recommended_action
      - review_queue_item_id
      title: ModerationCheckCompletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationCustomActionEvent:
      description: This event is sent when a custom moderation action is executed
      nullable: true
      properties:
        action_id:
          description: The ID of the custom action that was executed
          title: ActionID
          type: string
          x-stream-index: "002"
        action_options:
          additionalProperties: {}
          description: Additional options passed to the custom action
          title: ActionOptions
          type: object
          x-stream-index: "003"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: The message if the moderated content was a message
          title: Message
          x-stream-index: "005"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item the action was executed on
          title: ReviewQueueItem
          x-stream-index: "004"
        type:
          default: moderation.custom_action
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      - action_id
      - review_queue_item
      title: ModerationCustomActionEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationFlagResponse:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "015"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        entity_creator_id:
          type: string
          x-stream-index: "007"
        entity_id:
          type: string
          x-stream-index: "006"
        entity_type:
          type: string
          x-stream-index: "005"
        labels:
          items:
            type: string
          type: array
          x-stream-index: "011"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayloadResponse'
          x-stream-index: "008"
        reason:
          type: string
          x-stream-index: "009"
        result:
          items:
            additionalProperties: {}
            type: object
          type: array
          x-stream-index: "012"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          x-stream-index: "014"
        review_queue_item_id:
          type: string
          x-stream-index: "013"
        type:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "016"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "004"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - type
      - user_id
      - entity_type
      - entity_id
      - result
      - created_at
      - updated_at
      type: object
    ModerationFlaggedEvent:
      description: This event is sent when content is flagged for moderation
      nullable: true
      properties:
        content_type:
          description: The type of content that was flagged
          title: ContentType
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        object_id:
          description: The ID of the flagged content
          title: ObjectID
          type: string
          x-stream-index: "003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        type:
          default: moderation.flagged
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      - content_type
      - object_id
      title: ModerationFlaggedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationMarkReviewedEvent:
      description: This event is sent when a moderation item is marked as reviewed
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item that was marked as reviewed
          title: ReviewQueueItem
          x-stream-index: "001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: The message if the reviewed content was a message
          title: Message
          x-stream-index: "002"
        received_at:
          format: date-time
          type: string
          x-stream-index: "003.004"
        type:
          default: moderation.mark_reviewed
          type: string
          x-stream-index: "003.002"
      required:
      - item
      - type
      - created_at
      - custom
      title: ModerationMarkReviewedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationPayload:
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        images:
          items:
            type: string
          maxItems: 30
          type: array
          x-stream-index: "002"
        texts:
          items:
            type: string
          type: array
          x-stream-index: "001"
        videos:
          items:
            type: string
          type: array
          x-stream-index: "003"
      type: object
    ModerationPayloadResponse:
      description: Content payload for moderation
      properties:
        custom:
          additionalProperties: {}
          description: Custom data for moderation
          title: Custom
          type: object
          x-stream-index: "004"
        images:
          description: Image URLs to moderate
          items:
            type: string
          title: Images
          type: array
          x-stream-index: "002"
        texts:
          description: Text content to moderate
          items:
            type: string
          title: Texts
          type: array
          x-stream-index: "001"
        videos:
          description: Video URLs to moderate
          items:
            type: string
          title: Videos
          type: array
          x-stream-index: "003"
      title: ModerationPayload
      type: object
    ModerationRuleInfo:
      properties:
        description:
          type: string
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: "001"
        name:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "003"
      required:
      - id
      - name
      - type
      - description
      type: object
    ModerationRulesTriggeredEvent:
      description: This event is sent automatically whenever a rule builder rule is
        triggered
      nullable: true
      properties:
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        entity_id:
          description: The ID of the entity that triggered the rule
          title: EntityID
          type: string
          x-stream-index: "004"
        entity_type:
          description: The type of the entity (call, user, message, etc.)
          title: EntityType
          type: string
          x-stream-index: "005"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        review_queue_item_id:
          description: The review queue item ID if applicable
          title: ReviewQueueItemID
          type: string
          x-stream-index: "008"
        rule:
          $ref: '#/components/schemas/ModerationRuleInfo'
          description: The rule that was triggered
          title: Rule
          x-stream-index: "002"
        triggered_actions:
          description: Array of action types that were triggered
          items:
            type: string
          title: TriggeredActions
          type: array
          x-stream-index: "007"
        type:
          default: moderation_rule.triggered
          type: string
          x-stream-index: "001.002"
        user_id:
          description: The ID of the user who triggered the rule
          title: UserID
          type: string
          x-stream-index: "006"
        violation_number:
          description: The violation number for call rules (optional)
          format: int32
          title: ViolationNumber
          type: integer
          x-stream-index: "003"
      required:
      - type
      - created_at
      - custom
      - rule
      - entity_id
      - entity_type
      - user_id
      - triggered_actions
      title: ModerationRulesTriggeredEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationV2Response:
      properties:
        action:
          type: string
          x-stream-index: "001"
        blocklist_matched:
          type: string
          x-stream-index: "005"
        blocklists_matched:
          items:
            type: string
          type: array
          x-stream-index: "006"
        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: "008"
        semantic_filter_matched:
          type: string
          x-stream-index: "007"
        text_harms:
          items:
            type: string
          type: array
          x-stream-index: "003"
      required:
      - action
      - original_text
      type: object
    PollOptionResponseData:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      - text
      - custom
      type: object
    PollResponseData:
      properties:
        allow_answers:
          type: boolean
          x-stream-index: "008"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "007"
        answers_count:
          format: int32
          type: integer
          x-stream-index: "012"
        created_at:
          format: date-time
          type: 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
    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
    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
    PushNotificationSettingsResponse:
      properties:
        disabled:
          type: boolean
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: string
          x-stream-index: "002"
      type: object
    Reaction:
      properties:
        activity_id:
          type: string
          x-stream-index: "001.003"
        children_counts:
          additionalProperties: {}
          type: object
          x-stream-index: "005"
        created_at:
          format: date-time
          type: string
          x-stream-index: "006"
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "001.005"
        deleted_at:
          format: date-time
          type: string
          x-stream-index: "008"
        id:
          type: string
          x-stream-index: "001.001"
        kind:
          type: string
          x-stream-index: "001.002"
        latest_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/Reaction'
            type: array
          type: object
          x-stream-index: "003"
        moderation:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        own_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/Reaction'
            type: array
          type: object
          x-stream-index: "004"
        parent:
          type: string
          x-stream-index: "001.008"
        score:
          format: float
          type: number
          x-stream-index: "009"
        target_feeds:
          items:
            type: string
          type: array
          x-stream-index: "001.006"
        target_feeds_extra_data:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002"
        user_id:
          type: string
          x-stream-index: "001.004"
      required:
      - kind
      - activity_id
      - user_id
      - created_at
      - updated_at
      type: object
    ReactionGroupResponse:
      description: ReactionGroupResponse contains all information about a reaction
        of the same type.
      nullable: true
      properties:
        count:
          description: Count is the number of reactions of this type.
          format: int32
          title: Count
          type: integer
          x-stream-index: "001"
        first_reaction_at:
          description: FirstReactionAt is the time of the first reaction of this type.
            This is the same also if all reaction of this type are deleted, because
            if someone will react again with the same type, will be preserved the
            sorting.
          format: date-time
          title: FirstReactionAt
          type: string
          x-stream-index: "003"
        last_reaction_at:
          description: LastReactionAt is the time of the last reaction of this type.
          format: date-time
          title: LastReactionAt
          type: string
          x-stream-index: "004"
        latest_reactions_by:
          description: The most recent users who reacted with this type, ordered by
            most recent first.
          items:
            $ref: '#/components/schemas/ReactionGroupUserResponse'
          title: LatestReactionsBy
          type: array
          x-stream-index: "005"
        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
      - latest_reactions_by
      title: ReactionGroupResponse
      type: object
    ReactionGroupUserResponse:
      description: Contains information about a user who reacted with this reaction
        type.
      properties:
        created_at:
          description: The time when the user reacted.
          format: date-time
          title: CreatedAt
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The full user object.
          title: User
          x-stream-index: "002"
        user_id:
          description: The ID of the user who reacted.
          title: UserID
          type: string
          x-stream-index: "001"
      required:
      - user_id
      - created_at
      title: ReactionGroupUserResponse
      type: object
    ReactionResponse:
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "008"
        message_id:
          description: Message ID
          title: Message ID
          type: string
          x-stream-index: "001"
        score:
          description: Score of the reaction
          format: int32
          title: Score
          type: integer
          x-stream-index: "005"
        type:
          description: Type of reaction
          title: Type
          type: string
          x-stream-index: "004"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User
          title: UserResponse
          x-stream-index: "003"
        user_id:
          description: User ID
          title: User ID
          type: string
          x-stream-index: "002"
      required:
      - message_id
      - user_id
      - user
      - type
      - score
      - created_at
      - updated_at
      - custom
      type: object
    ReadReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    ReminderResponseData:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003"
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: 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
    ReviewQueueItemNewEvent:
      description: This event is sent when a new moderation review queue item is created
      nullable: true
      properties:
        action:
          $ref: '#/components/schemas/ActionLogResponse'
          description: The action log if any action was taken
          title: Action
          x-stream-index: "004"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        flags:
          description: The flags associated with this review queue item
          items:
            $ref: '#/components/schemas/ModerationFlagResponse'
          title: Flags
          type: array
          x-stream-index: "003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item that was created
          title: ReviewQueueItem
          x-stream-index: "002"
        type:
          default: review_queue_item.new
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      title: ReviewQueueItemNewEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReviewQueueItemResponse:
      properties:
        actions:
          description: Moderation actions taken
          items:
            $ref: '#/components/schemas/ActionLogResponse'
          title: Actions
          type: array
          x-stream-index: "025"
        activity:
          $ref: '#/components/schemas/EnrichedActivity'
          x-stream-index: "017"
        ai_text_severity:
          description: AI-determined text severity
          title: AI Text Severity
          type: string
          x-stream-index: "014"
        appeal:
          $ref: '#/components/schemas/AppealItemResponse'
          description: Appeal submitted for this item if it exists
          title: Appeal
          x-stream-index: "026"
        assigned_to:
          $ref: '#/components/schemas/UserResponse'
          description: Moderator assigned to review this item
          title: Assigned To
          x-stream-index: "022"
        bans:
          description: Associated ban records
          items:
            $ref: '#/components/schemas/BanInfoResponse'
          title: Bans
          type: array
          x-stream-index: "023"
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "019"
        completed_at:
          description: When the review was completed
          format: date-time
          title: Completed At
          type: string
          x-stream-index: "009"
        config_key:
          type: string
          x-stream-index: "032"
        created_at:
          description: When the item was created
          format: date-time
          title: Created At
          type: string
          x-stream-index: "002"
        entity_creator:
          $ref: '#/components/schemas/EntityCreatorResponse'
          description: Details about who created the entity
          title: Entity Creator
          x-stream-index: "020"
        entity_creator_id:
          description: ID of who created the entity
          title: Entity Creator ID
          type: string
          x-stream-index: "021"
        entity_id:
          description: ID of the entity being reviewed
          title: Entity ID
          type: string
          x-stream-index: "005"
        entity_type:
          description: Type of entity being reviewed
          title: Entity Type
          type: string
          x-stream-index: "004"
        escalated:
          description: Whether the item has been escalated
          title: Escalated
          type: boolean
          x-stream-index: "034"
        escalated_at:
          description: When the item was escalated
          format: date-time
          title: Escalated At
          type: string
          x-stream-index: "037"
        escalated_by:
          description: ID of the moderator who escalated the item
          title: Escalated By
          type: string
          x-stream-index: "036"
        escalation_metadata:
          $ref: '#/components/schemas/EscalationMetadata'
          description: Escalation details including reason, notes, and priority
          title: Escalation Metadata
          x-stream-index: "035"
        feeds_v2_activity:
          $ref: '#/components/schemas/EnrichedActivity'
          description: Associated feed activity
          title: Feeds V2 Activity
          x-stream-index: "027"
        feeds_v2_reaction:
          $ref: '#/components/schemas/Reaction'
          description: Associated feed reaction
          title: Feeds V2 Reaction
          x-stream-index: "028"
        feeds_v3_activity:
          $ref: '#/components/schemas/FeedsV3ActivityResponse'
          x-stream-index: "029"
        feeds_v3_comment:
          $ref: '#/components/schemas/FeedsV3CommentResponse'
          x-stream-index: "030"
        flags:
          description: Associated flag records
          items:
            $ref: '#/components/schemas/ModerationFlagResponse'
          title: Flags
          type: array
          x-stream-index: "024"
        flags_count:
          format: int32
          type: integer
          x-stream-index: "033"
        id:
          description: Unique identifier of the review queue item
          title: ID
          type: string
          x-stream-index: "001"
        languages:
          description: Detected languages in the content
          items:
            type: string
          title: Languages
          type: array
          x-stream-index: "012"
        latest_moderator_action:
          type: string
          x-stream-index: "015"
        message:
          $ref: '#/components/schemas/ChatMessageResponse'
          description: Associated message details
          title: Message
          x-stream-index: "016"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayloadResponse'
          description: Content being moderated
          title: Moderation Payload
          x-stream-index: "006"
        reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "018"
        recommended_action:
          description: Suggested moderation action
          title: Recommended Action
          type: string
          x-stream-index: "008"
        reviewed_at:
          description: When the item was reviewed
          format: date-time
          title: Reviewed At
          type: string
          x-stream-index: "010"
        reviewed_by:
          description: ID of the moderator who reviewed the item
          title: Reviewed By
          type: string
          x-stream-index: "011"
        severity:
          description: Severity level of the content
          format: int32
          title: Severity
          type: integer
          x-stream-index: "013"
        status:
          description: Current status of the review
          title: Status
          type: string
          x-stream-index: "007"
        teams:
          description: Teams associated with this item
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "031"
        updated_at:
          description: When the item was last updated
          format: date-time
          title: Updated At
          type: string
          x-stream-index: "003"
      required:
      - id
      - created_at
      - updated_at
      - entity_type
      - entity_id
      - status
      - recommended_action
      - reviewed_by
      - languages
      - severity
      - ai_text_severity
      - latest_moderator_action
      - bans
      - flags
      - actions
      - flags_count
      - escalated
      type: object
    ReviewQueueItemUpdatedEvent:
      description: This event is sent when a moderation review queue item is updated
      nullable: true
      properties:
        action:
          $ref: '#/components/schemas/ActionLogResponse'
          description: The action log if any action was taken
          title: Action
          x-stream-index: "004"
        created_at:
          format: date-time
          type: string
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        flags:
          description: The flags associated with this review queue item
          items:
            $ref: '#/components/schemas/ModerationFlagResponse'
          title: Flags
          type: array
          x-stream-index: "003"
        received_at:
          format: date-time
          type: string
          x-stream-index: "001.004"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item that was updated
          title: ReviewQueueItem
          x-stream-index: "002"
        type:
          default: review_queue_item.updated
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      title: ReviewQueueItemUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    RuleResponse:
      properties:
        condition:
          additionalProperties: {}
          description: MongoDB expression that determines if the defined actions should
            be executed
          title: Condition
          type: object
          x-stream-index: "004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "006"
        evaluations:
          items:
            $ref: '#/components/schemas/EvaluationResponse'
          type: array
          x-stream-index: "003"
        filter:
          additionalProperties: {}
          description: Filter object that selects a task based on its attributes,
            eg. content-type or channel type.
          title: Filter
          type: object
          x-stream-index: "002"
        id:
          description: Rule ID
          title: ID
          type: string
          x-stream-index: "001"
        triggers:
          description: List of triggers
          items:
            $ref: '#/components/schemas/TriggerResponse'
          title: Triggers
          type: array
          x-stream-index: "005"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "007"
      required:
      - id
      - filter
      - evaluations
      - condition
      - triggers
      - created_at
      - updated_at
      title: RuleResponse
      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
    SubmitChatMessageTaskRequest:
      nullable: true
      properties:
        channel_id:
          description: The Channel ID
          title: Channel ID
          type: string
          x-stream-index: "003"
        channel_name:
          description: The Channel Name, if not provided matches the Channel ID
          title: Channel Name
          type: string
          x-stream-index: "005"
        evaluations:
          description: a list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/EvaluationPayload'
          title: Evaluations
          type: array
          x-stream-index: "008"
        extra:
          additionalProperties: {}
          description: Extra data that needs to be stored for this task
          title: Extra
          type: object
          x-stream-index: "007"
        message_id:
          description: The ID of the message so the system can know on which message
            to act if moderation is needed
          title: Message ID
          type: string
          x-stream-index: "001"
        text:
          description: The message text sent for evaluation
          title: Text
          type: string
          x-stream-index: "006"
        user_id:
          description: The User ID
          title: User ID
          type: string
          x-stream-index: "002"
        user_name:
          description: The User Name, if not provided matches the User ID
          title: User Name
          type: string
          x-stream-index: "004"
      required:
      - message_id
      - user_id
      - channel_id
      - text
      title: SubmitChatMessageTaskRequest
      type: object
    SubmitChatMessageTaskResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        task:
          $ref: '#/components/schemas/ChatMessageTaskResponse'
          title: Task
          x-stream-index: "001"
      required:
      - task
      - duration
      title: SubmitChatMessageTaskResponse
      type: object
    SubmitTaskRequest:
      nullable: true
      properties:
        content_type:
          description: Type of payload for this task
          enum:
          - text
          title: Content Type
          type: string
          x-stream-index: "001"
        evaluations:
          description: a list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/EvaluationPayload'
          title: Evaluations
          type: array
          x-stream-index: "004"
        extra:
          additionalProperties: {}
          description: Extra data that needs to be stored for this task
          title: Extra
          type: object
          x-stream-index: "003"
        payload:
          additionalProperties: {}
          description: Depending on the content type this can be a string, a url or
            a complex stream object
          title: Payload
          type: object
          x-stream-index: "002"
      required:
      - content_type
      - payload
      title: SubmitTaskRequest
      type: object
    SubmitTaskResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        task:
          $ref: '#/components/schemas/TaskResponse'
          title: Task
          x-stream-index: "001"
      required:
      - task
      - duration
      title: SubmitTaskResponse
      type: object
    TaskResponse:
      properties:
        assigned_to:
          description: The person that this task is assigned to
          title: Assigned To
          type: string
          x-stream-index: "009"
        content_type:
          description: Type of payload for this task
          title: Content Type
          type: string
          x-stream-index: "003"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "012"
        evaluations:
          description: a list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/EvaluationResponse'
          title: Evaluations
          type: array
          x-stream-index: "006"
        extra:
          additionalProperties: {}
          description: Extra data that needs to be stored for this task
          title: Extra
          type: object
          x-stream-index: "005"
        id:
          description: 'Task ID '
          title: ID
          type: string
          x-stream-index: "001"
        reviewed_at:
          description: The time when the review happened
          format: date-time
          title: Reviewed At
          type: string
          x-stream-index: "010"
        reviewed_by:
          description: The person who did the review
          title: Reviewed By
          type: string
          x-stream-index: "011"
        rule:
          $ref: '#/components/schemas/RuleResponse'
          title: Rule
          x-stream-index: "007"
        status:
          description: Status of the task. Sync tasks can be completed or error, async
            tasks can be in pending state
          title: Status
          type: string
          x-stream-index: "002"
        triggers:
          description: A list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/TriggerResponse'
          title: Triggers
          type: array
          x-stream-index: "008"
        updated_at:
          format: date-time
          type: string
          x-stream-index: "013"
      required:
      - id
      - status
      - content_type
      - payload
      - evaluations
      - created_at
      - updated_at
      title: TaskResponse
      type: object
    Thresholds:
      description: Sets thresholds for AI moderation
      properties:
        explicit:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for explicit messages
          title: LabelThresholds
          x-stream-index: "001"
        spam:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for spam
          title: LabelThresholds
          x-stream-index: "002"
        toxic:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for toxic messages
          title: LabelThresholds
          x-stream-index: "003"
      title: Auto moderation thresholds
      type: object
    Time:
      type: object
    TriggerPayload:
      nullable: true
      properties:
        options:
          additionalProperties: {}
          description: Trigger options
          title: Options
          type: object
          x-stream-index: "002"
        type:
          description: Trigger type
          title: Type
          type: string
          x-stream-index: "001"
      title: TriggerPayload
      type: object
    TriggerResponse:
      properties:
        options:
          additionalProperties: {}
          description: Trigger options
          title: Options
          type: object
          x-stream-index: "002"
        type:
          description: Trigger type
          title: Type
          type: string
          x-stream-index: "001"
      required:
      - type
      title: TriggerResponse
      type: object
    TypingIndicatorsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    UpdateTaskRequest:
      nullable: true
      properties:
        assigned_to:
          description: The person that this task is assigned to
          title: Assigned To
          type: string
          x-stream-index: "004"
        evaluations:
          description: a list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/EvaluationPayload'
          title: Evaluations
          type: array
          x-stream-index: "002"
        reviewed_at:
          description: The time when the review happened
          format: date-time
          title: Reviewed At
          type: string
          x-stream-index: "005"
        reviewed_by:
          description: The person who did the review
          title: Reviewed By
          type: string
          x-stream-index: "006"
        triggers:
          description: A list of harm engines / models to be evaluated
          items:
            $ref: '#/components/schemas/TriggerPayload'
          title: Triggers
          type: array
          x-stream-index: "003"
      title: UpdateTaskRequest
      type: object
    UpdateTaskResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        task:
          $ref: '#/components/schemas/TaskResponse'
          title: Task
          x-stream-index: "001"
      required:
      - task
      - duration
      title: UpdateTaskResponse
      type: object
    User:
      properties:
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
        id:
          type: string
          x-stream-index: "001"
      required:
      - id
      type: object
    UserResponse:
      description: User response object
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        ban_expires:
          description: Date when ban expires
          format: date-time
          title: Ban expires
          type: string
          x-stream-index: "004"
        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"
        bypass_moderation:
          type: boolean
          x-stream-index: "003"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: string
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          description: Date of deactivation
          format: date-time
          title: Deactivated at
          type: string
          x-stream-index: "001.016"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: string
          x-stream-index: "001.011"
        devices:
          description: List of devices user is using
          items:
            $ref: '#/components/schemas/DeviceResponse'
          title: Devices
          type: array
          x-stream-index: "007"
        id:
          description: Unique user identifier
          title: ID
          type: string
          x-stream-index: "001.001"
        image:
          title: Image
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "008"
        language:
          description: Preferred language of a user
          title: Language
          type: string
          x-stream-index: "001.005"
        last_active:
          description: Date of last activity
          format: date-time
          title: Last active
          type: string
          x-stream-index: "001.014"
        name:
          description: Optional name of user
          title: Name
          type: string
          x-stream-index: "001.002"
        online:
          description: Whether a user online or not
          title: Online
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          description: User privacy settings
          title: Privacy settings
          x-stream-index: "006"
        push_notifications:
          $ref: '#/components/schemas/PushNotificationSettingsResponse'
          description: User push notification settings
          title: Push notifications
          x-stream-index: "005"
        revoke_tokens_issued_before:
          description: Revocation date for tokens
          format: date-time
          title: Revoke tokens issued before
          type: string
          x-stream-index: "001.015"
        role:
          description: Determines the set of user permissions
          title: Role
          type: string
          x-stream-index: "001.006"
        shadow_banned:
          description: Whether a user is shadow banned
          title: Shadow banned
          type: boolean
          x-stream-index: "002"
        teams:
          description: List of teams user is a part of
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: string
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      - shadow_banned
      - invisible
      title: UserResponse
      type: object
    WHEvent:
      description: The discriminator object for all webhook events, it maps events'
        payload to the final type
      discriminator:
        mapping:
          appeal.accepted: '#/components/schemas/AppealAcceptedEvent'
          appeal.created: '#/components/schemas/AppealCreatedEvent'
          appeal.rejected: '#/components/schemas/AppealRejectedEvent'
          export.bulk_image_moderation.error: '#/components/schemas/AsyncExportErrorEvent'
          export.bulk_image_moderation.success: '#/components/schemas/AsyncBulkImageModerationEvent'
          export.moderation_logs.error: '#/components/schemas/AsyncExportErrorEvent'
          export.moderation_logs.success: '#/components/schemas/AsyncExportModerationLogsEvent'
          moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent'
          moderation.flagged: '#/components/schemas/ModerationFlaggedEvent'
          moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent'
          moderation_check.completed: '#/components/schemas/ModerationCheckCompletedEvent'
          moderation_rule.triggered: '#/components/schemas/ModerationRulesTriggeredEvent'
          review_queue_item.new: '#/components/schemas/ReviewQueueItemNewEvent'
          review_queue_item.updated: '#/components/schemas/ReviewQueueItemUpdatedEvent'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/AppealAcceptedEvent'
      - $ref: '#/components/schemas/AppealCreatedEvent'
      - $ref: '#/components/schemas/AppealRejectedEvent'
      - $ref: '#/components/schemas/AsyncBulkImageModerationEvent'
      - $ref: '#/components/schemas/AsyncExportErrorEvent'
      - $ref: '#/components/schemas/AsyncExportErrorEvent'
      - $ref: '#/components/schemas/AsyncExportModerationLogsEvent'
      - $ref: '#/components/schemas/ModerationCheckCompletedEvent'
      - $ref: '#/components/schemas/ModerationCustomActionEvent'
      - $ref: '#/components/schemas/ModerationFlaggedEvent'
      - $ref: '#/components/schemas/ModerationMarkReviewedEvent'
      - $ref: '#/components/schemas/ModerationRulesTriggeredEvent'
      - $ref: '#/components/schemas/ReviewQueueItemNewEvent'
      - $ref: '#/components/schemas/ReviewQueueItemUpdatedEvent'
  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: v228.4.0
openapi: 3.0.3
paths:
  /api/v1/moderation/chat_message_tasks:
    post:
      description: |
        Submits a chat message task
      operationId: SubmitChatMessageTask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitChatMessageTaskRequest'
        description: SubmitChatMessageTaskRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitChatMessageTaskResponse'
          description: SubmitChatMessageTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Submit Chat Message Task
      tags:
      - product:moderation
  /api/v1/moderation/dashboard/blocked_messages:
    get:
      description: |
        TODO
      operationId: ListBlockedMessages
      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
      tags:
      - product:moderation
  /api/v1/moderation/dashboard/flag_feedback:
    post:
      description: |
        TODO
      operationId: FlagFeedback
      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
      tags:
      - product:moderation
  /api/v1/moderation/dashboard/moderation_log:
    get:
      description: |
        TODO
      operationId: ListModerationLogs
      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
      tags:
      - product:moderation
  /api/v1/moderation/dashboard/update_flags:
    post:
      description: |
        TODO
      operationId: UpdateFlags
      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
      tags:
      - product:moderation
  /api/v1/moderation/moderation/blocked_messages:
    get:
      description: |
        TODO
      operationId: ListBlockedMessages
      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
      tags:
      - product:moderation
  /api/v1/moderation/moderation/flag_feedback:
    post:
      description: |
        TODO
      operationId: FlagFeedback
      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
      tags:
      - product:moderation
  /api/v1/moderation/moderation/moderation_log:
    get:
      description: |
        TODO
      operationId: ListModerationLogs
      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
      tags:
      - product:moderation
  /api/v1/moderation/moderation/update_flags:
    post:
      description: |
        TODO
      operationId: UpdateFlags
      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
      tags:
      - product:moderation
  /api/v1/moderation/tasks:
    get:
      description: |
        Lists all tasks
      operationId: ListTasks
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTasksResponse'
          description: ListTasksResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List Tasks
      tags:
      - product:moderation
    post:
      description: |
        Submits a task
      operationId: SubmitTask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitTaskRequest'
        description: SubmitTaskRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitTaskResponse'
          description: SubmitTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Submit Task
      tags:
      - product:moderation
  /api/v1/moderation/tasks/{id}:
    get:
      description: |
        Fetches moderation task
      operationId: GetTask
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: 'Task ID '
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTaskResponse'
          description: GetTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get Task
      tags:
      - product:moderation
    post:
      description: |
        Updates a task
      operationId: UpdateTask
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: 'Task ID '
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaskRequest'
        description: UpdateTaskRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTaskResponse'
          description: UpdateTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update Task
      tags:
      - product:moderation
  /automod/v1/chat_message_tasks:
    post:
      description: |
        Submits a chat message task
      operationId: SubmitChatMessageTask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitChatMessageTaskRequest'
        description: SubmitChatMessageTaskRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitChatMessageTaskResponse'
          description: SubmitChatMessageTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Submit Chat Message Task
      tags:
      - product:moderation
  /automod/v1/dashboard/blocked_messages:
    get:
      description: |
        TODO
      operationId: ListBlockedMessages
      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
      tags:
      - product:moderation
  /automod/v1/dashboard/flag_feedback:
    post:
      description: |
        TODO
      operationId: FlagFeedback
      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
      tags:
      - product:moderation
  /automod/v1/dashboard/moderation_log:
    get:
      description: |
        TODO
      operationId: ListModerationLogs
      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
      tags:
      - product:moderation
  /automod/v1/dashboard/update_flags:
    post:
      description: |
        TODO
      operationId: UpdateFlags
      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
      tags:
      - product:moderation
  /automod/v1/moderation/blocked_messages:
    get:
      description: |
        TODO
      operationId: ListBlockedMessages
      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
      tags:
      - product:moderation
  /automod/v1/moderation/flag_feedback:
    post:
      description: |
        TODO
      operationId: FlagFeedback
      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
      tags:
      - product:moderation
  /automod/v1/moderation/moderation_log:
    get:
      description: |
        TODO
      operationId: ListModerationLogs
      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
      tags:
      - product:moderation
  /automod/v1/moderation/update_flags:
    post:
      description: |
        TODO
      operationId: UpdateFlags
      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
      tags:
      - product:moderation
  /automod/v1/tasks:
    get:
      description: |
        Lists all tasks
      operationId: ListTasks
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTasksResponse'
          description: ListTasksResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: List Tasks
      tags:
      - product:moderation
    post:
      description: |
        Submits a task
      operationId: SubmitTask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitTaskRequest'
        description: SubmitTaskRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitTaskResponse'
          description: SubmitTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Submit Task
      tags:
      - product:moderation
  /automod/v1/tasks/{id}:
    get:
      description: |
        Fetches moderation task
      operationId: GetTask
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: 'Task ID '
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTaskResponse'
          description: GetTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get Task
      tags:
      - product:moderation
    post:
      description: |
        Updates a task
      operationId: UpdateTask
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: 'Task ID '
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaskRequest'
        description: UpdateTaskRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTaskResponse'
          description: UpdateTaskResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Update Task
      tags:
      - product:moderation
security:
- JWT: []
  api_key: []
  stream-auth-type: []
- api_key: []
  stream-auth-type: []
servers:
- description: Stream API
  url: https://chat.stream-io-api.com